-
Notifications
You must be signed in to change notification settings - Fork 86
How to create a KIT website?
Following our project structure, the collection of our KITs documentation is developed in the ./docs-kits/kits
folder, where each KIT is a subfolder called by its name for organisation purposes. The Data Chain KIT
, for example, is defined here: ./docs-kits/kits/Data Chain Kit
.
Each folder/KIT's content is structured in at least four pages/subfolders:
- Adoption View ->
page_adoption-view.md
- Software Operation View ->
page_software-operation-view.md
- Documentation ->
page_documentation.md
- Software Development View/
- Specification ->
page_software-development-view.md
- OpenAPI definition/
- Another OpenAPI definition/
- ...
- Specification ->
- Create a folder under the
./docs-kits/kits
with the name of the KIT you are developing the documentation of
root
|---docs-kits
|--NewKIT
- Inside the
NewKIT
folder, add apage_adoption-view.md
file with the content that suits your use case
root
|--docs-kits
|--NewKIT
|--page_adoption-view.md
- Inside the
NewKIT
folder, add apage_software-operation-view.md
file with the content that suits your use case
root
|--docs-kits
|--NewKIT
|--page_adoption-view.md
|--page_software-operation-view.md
- Inside the
NewKIT
folder, add apage_documentation.md
file with the content that suits your use case
root
|--docs-kits
|--NewKIT
|--page_adoption-view.md
|--page_software-operation-view.md
|--page_documentation.md
- Inside the
NewKIT
folder, add aSoftware Development View
folder that contains apage_software-development-view.md
file with the content that suits your use case
root
|--docs-kits
|--NewKIT
|--page_adoption-view.md
|--page_software-operation-view.md
|--page_documentation.md
|--Software Development View
|--page_software-development-view.md
-
To generate the
OpenAPI
based documentation of your KIT, please consult the Plugins section to configure your instance of theDocusaurus-OpenAPI-Docs
in thedocusaurus.config.js
. -
Add your newly created KIT documentation to the Kits
sidebar
page, by incorporating the following declaration in the sidebar object of thesidebarsDocsKits.js
file:
const sidebars = {
kits: [
// copy from here...
{
type: 'category',
label: 'New KIT name', //change here according your KIT
link: {
type: 'generated-index',
},
collapsed: true,
items: [
{
type: 'autogenerated',
dirName: 'kits/New KIT folder name given', //change here according your KIT
},
],
},
// ...until here.
],
};
Note the sidebars may required bigger customisation based on your requirements, for that matters consult the official documentation