Monorepo of content and API reference of Setu docs
You can find content for Setu docs in /content
folder
- Each category is a folder with products as sub-folders and content files inside product folders.
- All content files are MDX
endpoints.json
- Object with categories and products in Setu docsredirects.json
- key-value pairs contains information about redirecting from one slug to anothermenuItems.json
contains fully nested object for the docs sidebar (DO NOT TOUCH)
Create a new branch and raise a PR for every edit you want to make to the documentation.
To edit any page, you can either,
- clone this repo in your local and edit using VS Code
- or just press
.
after logging into GitHub to open online VS Code
Cloning and editing in local is faster due to virtual workspace in online VS Code
Go through this detailed guide on how to write content
For easy syntax higlighting, VSCode MDX
- Install this extension from marketplace.
- or you can install in VS Code by the extensions tab in the leftside bar or press
Shift + Cmd/Ctrl + X
and search forMDX
For documentation preview, Docter Preview
- Install this extension from marketplace.
- You can install in VS Code by the extensions tab in the leftside bar or press
Shift + Cmd/Ctrl + X
and search forDocter Preview
Using the Docter Preview
extension, we can preview content and sidebar changes. Please go through the README to learn about the features and follow the steps mentioned to use it.
You can find API reference spec files for Setu docs in /api-reference
folder
- Each category is a folder with products as API reference spec files in JSON or YAML format.
- All API reference files are in JSON or YAML format
You can now use Setu's pre-built editor to preview API references. Visit the preview page, copy your content and generate an API reference preview.
Currently this only works for JSON files. Support for YAML is WIP and should be available soon.