Skip to content

Commit cf58c54

Browse files
committed
Create README.md
1 parent a5c1c2b commit cf58c54

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

tools/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Tools for docs
2+
3+
This folder contains a set of tools to automate the routine docs work. You should run the command from `docs` root folder not in the tools folder.
4+
5+
- `yarn run spellcheck` to run spell spellcheck
6+
- `sh tools/autogenerate-downloads.sh` to generate release-downloads.md based on file list in S3
7+
- `bun tools/list-pages.ts` to show nav tree based on sidebars.js and titles in markdown files
8+
- `bun tools/missing.js` to list which markdown files are not mounted in sidebars.js
9+
10+
Other files probably are outdated.

0 commit comments

Comments
 (0)