Skip to content

Commit d80a556

Browse files
authored
Add doctoc instructions to README. (#289)
1 parent e443b43 commit d80a556

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ directory after it is completed.
2222
- `governance` contains governance level features
2323
- `security` contains failure mode analysis documents
2424

25+
[`doctoc`](https://www.npmjs.com/package/doctoc) is used for maintaining tables of contents.
26+
For an example of usage, see the [FMA Template](https://github.com/ethereum-optimism/design-docs/blob/main/assets/fma-template.md?plain=1).
27+
28+
Usage:
29+
1. `npm install -g doctoc`
30+
2. `doctoc <filename>`
31+
2532
## Design Review Sessions
2633

2734
The agendas for design doc review sessions are being tracked on

0 commit comments

Comments
 (0)