Updated README to add basic information about indexing the docs
This commit is contained in:
committed by
fabioberger
parent
1985fec892
commit
be0662a41d
@@ -55,6 +55,16 @@ yarn clean
|
||||
yarn lint
|
||||
```
|
||||
|
||||
### Indexing docs
|
||||
|
||||
```bash
|
||||
yarn index_docs
|
||||
```
|
||||
|
||||
The above script will index all the docs found in the `/mdx` folder. It's possible to pass in arguments that match the directory names to index only those document types, i.e. `yarn index_docs tools core-concepts` will index tools and core concepts.
|
||||
|
||||
Running the script updates some of the meta information about the files (relative paths to files and versions of the doc). For other types of information (i.e. title, subtitle, tags...) you will have to update it yourself.
|
||||
|
||||
### Resources
|
||||
|
||||
##### Toolkit
|
||||
|
||||
Reference in New Issue
Block a user