Skip to content

Commit

Permalink
added changelog as required file and changed ordering of files
Browse files Browse the repository at this point in the history
  • Loading branch information
Grand-Thibault authored Feb 25, 2025
1 parent cc9ffd7 commit 73e9fc0
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions docs/website-guidelines/kit-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,69 +28,82 @@ Each folder/KIT's content is structured in at least four pages/subfolders:
└── new-kit
```

2. Inside the `new-kit` folder, add a `adoption-view.md` file with the content that suits your use case.
2. Inside the `new-kit` folder, add a `changelog.md` file.

```md
root
└── docs-kits
└── kits
└── new-kit
└── page_adoption-view.md
└── changelog.md

3. Inside the `new-kit` folder, add a `adoption-view.md` file with the content that suits your use case.

```md
root
└── docs-kits
└── kits
└── new-kit
├── changelog.md
└── adoption-view.md
```

3. Inside the `new-kit` folder, add a `software-operation-view.md` file with the content that suits your use case.
4. Inside the `new-kit` folder, add a `software-development-view.md` file with the content that suits your use case.

```md
root
└── docs-kits
└── kits
└── new-kit
├── changelog.md
├── adoption-view.md
└── software-operation-view.md
└── software-development-view.md
```

4. Inside the `new-kit` folder, add a `documentation.md` file with the content that suits your use case.
5. Inside the `new-kit` folder, add a `software-operation-view.md` file with the content that suits your use case.

```md
root
└── docs-kits
└── kits
└── new-kit
├── changelog.md
├── adoption-view.md
├── software-operation-view.md
└── documentation.md
├── software-development.md
└── software-operation-view.md
```

5. Inside the `new-kit` folder, add a `software-development-view.md` file with the content that suits your use case.
6. Inside the `new-kit` folder, add a `documentation.md` file with the content that suits your use case.

```md
root
└── docs-kits
└── kits
└── new-kit
├── changelog.md
├── adoption-view.md
├── software-development.md
├── software-operation-view.md
├── documentation.md
└── software-development-view.md
```
└── documentation.md

6. If you want to add additional pages to your KIT, add a folder with the same name as the .md file under which the pages should be added (e.g.`software-development-view` - `software-development-view.md`) and place the .md in it and the additional pages.
7. If you want to add additional pages to your KIT, add a folder with the same name as the .md file under which the pages should be added (e.g.`software-development-view` - `software-development-view.md`) and place the .md in it and the additional pages.

```md
root
└── docs-kits
└── kits
└── new-kit
├── changelog.md
├── adoption-view.md
├── software-operation-view.md
├── documentation.md
└── software-development-view
├── software-development-view.md
└── additional-page.md
└── documentation.md

```

7. To generate the `OpenAPI` based documentation of your KIT, please publish the API on SwaggerHub
8. To generate the `OpenAPI` based documentation of your KIT, please publish the API on SwaggerHub

**For KITs without reference implementation:**

Expand Down

0 comments on commit 73e9fc0

Please sign in to comment.