Skip to content

Commit 6a600be

Browse files
authored
Merge pull request #51 from UMLCloudComputing/docsupdate
feat: Improve project documentation structure and guidelines
2 parents e9b5e04 + da7cb7a commit 6a600be

File tree

1 file changed

+2
-16
lines changed

1 file changed

+2
-16
lines changed

README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -139,26 +139,14 @@ To add a new project's documentation onto the project docs section of the websit
139139
└── intro.md | Introduction/
140140
_category_.json
141141
```
142-
3. The project's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> This includes having proper front-matter and an appropriate `_category_.json` file for each folder.
143-
144-
Front Matter requirements:
145-
1. All markdown files must have the following front-matter: (`#` is an integer)
142+
3. The project's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> The `_category_.json` file is autogenerated at website build time. The order in which the projects are displayed on the website is determined by the order in which the projects are listed in the `repos.json` file (top to bottom order).
143+
4. Front Matter requirements: All markdown files must have the following front-matter: (`#` is an integer). This will affect the order in which the doc pages are displayed on the website (top to bottom order).
146144
``` text
147145
---
148146
sidebar_position: #
149147
---
150148
```
151149

152-
2. Each folder and subfolder must contain a `_category_.json` file. Each `.json` file should be contain the following content:
153-
``` json
154-
{
155-
"label": "My Project",
156-
"position": #,
157-
"link": {
158-
"type": "generated-index"
159-
}
160-
}
161-
```
162150
Here the label should be your own. The label indicates the labeled name of the folder or subfolder to be shown. IE project name (`My Project`), subsection name (`Excersices`), etc. <br/>
163151
The position value should also be customized to an `integer` representing the position of your folder or subfolder relative to other subfolders.
164152

@@ -174,8 +162,6 @@ react-mui-resume
174162
│ └── Intro.md
175163
```
176164

177-
178-
179165
### In order to add your project:
180166
1. Create a new branch from the **main** branch
181167
2. Name the branch with the following convention: `feat: Add new project docs: PROJECTNAME` with `PROJECTNAME` being the name of your project.

0 commit comments

Comments
 (0)