Getting started with Docs

Navigate through the existing docs using the sidebar

This is a single website used to hold all the OSlash Readme documents across all repositories.

To create a new markdown document, ensure consistency with the folder structure under pages as the same will be rendered as a sidebar in the website.

Make sure to use the extension .md or .mdx for all the documents.

Please use relative path ("./filename" instead of "filename") when linking or referencing files in a markdown file.

For instance, if you want to create a document named Search-workflow.md for 'search', create a folder named 'search' under pages and create the markdown under the folder.

The same will be then visible as 'Search/Search-workflow.md' in the sidebar.

Similarly, if you want multiple documents under a single folder, create a folder with the name of the folder you want to create and add the documents under it.

Any folder under pages will be rendered as a sidebar in the website.

Any markdown document under pages will be rendered as a page in the website.

There will be a _meta.json file under every page. It can be used to rename the pages or hide them. It is a key value pair which takes Strings as the name of the file and the Value which is to be displayed on the webpage.

For instance, If a directory has test.md which has to be displayed as "home" on the Webpage, the following can be entered in _meta.json file :

{
    "test": "home"
}

To hide a test.md page from being displayed on the webpage, the following can be used in _meta.json :

{
    "test" : 
    {
        "display":"hidden"
    }
}

An example of the folder structure is as follows:

pages
├── search
│   ├── _meta.json
│   ├── Search-workflow.md
│   └── Search-architecture.md
├── index.md
├── Bumblebee
│   ├── _meta.json
│   ├── Bumblebee.md
│   └── Bumblebee-architecture.md
├── clyde
│   ├── _meta.json
│   ├── clyde.md
│   └── clyde-frontend.md