Skip to content

Commit aaf6bff

Browse files
committed
Fixes.
1 parent 70e7bb4 commit aaf6bff

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
3535
└── versions.json # list of versions
3636
```
3737

38-
### How to organize the docs?
38+
### How To Organize the Docs?
3939

4040
- Prioritize the `concept` section. If this is about a MEP, you likely already have the contents for this.
4141
- Use the `general` section to distribute users to their sections or to the deeper concept.
@@ -146,7 +146,8 @@ To update the dependencies for the Reference pages:
146146
bun run fetch-readmes
147147
```
148148

149-
## Component references
149+
## Component References
150+
150151
Ensure first, that all files in the docs folder are updated and ready to freeze. Also execute `bun run fetch-readmes` to update files from components and apis with the release-vector file from the main branch.
151152
It is also possible to use `bun run fetch-readmes v0.20.8` to use the release-vector file with a specific tag (i.E. v0.20.8).
152153
All components are referenced in the `/scripts/components.json` file. Use this minimal template to add a new component:
@@ -160,7 +161,7 @@ All components are referenced in the `/scripts/components.json` file. Use this m
160161
"tag": "v0.18.1", // latest release tag of the component repository
161162
"position": 1, // use this property to sort the navigation subdirectories
162163
"withDocs": true // set to true to retrieve further .md files from a /docs folder. With false, only the README.md will be retrieved.
163-
},
164+
}
164165
```
165166

166167
The `tag` property will be updated automatically from the release-vector file.

0 commit comments

Comments
 (0)