You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
35
35
└── versions.json # list of versions
36
36
```
37
37
38
-
### How to organize the docs?
38
+
### How To Organize the Docs?
39
39
40
40
- Prioritize the `concept` section. If this is about a MEP, you likely already have the contents for this.
41
41
- 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:
146
146
bun run fetch-readmes
147
147
```
148
148
149
-
## Component references
149
+
## Component References
150
+
150
151
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.
151
152
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).
152
153
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
160
161
"tag":"v0.18.1", // latest release tag of the component repository
161
162
"position":1, // use this property to sort the navigation subdirectories
162
163
"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
+
}
164
165
```
165
166
166
167
The `tag` property will be updated automatically from the release-vector file.
0 commit comments