This repo mixes Docusaurus site code with project documentation and static assets. Keeping new files in the right place is the simplest way to keep it navigable.
docs/basics/: onboarding and "start here" contentdocs/guides/: workflow and tooling guidesdocs/projects/: project documentationdocs/products/: hardware reference pagessrc/pages/: standalone site pages outside the docs pluginsrc/components/: reusable React/MDX componentsstatic/img/: images grouped by domain (guides/,products/,SVG/,mascot/)scripts/: maintenance scripts for the docs site
- Prefer one folder per project under
docs/projects/ - Keep documentation pages together and name them by purpose:
overview,bom,schematics,firmware,deployment - Keep source assets next to the project only when they are project-specific, such as firmware or CAD files
- If a project is brought in as a submodule, treat it as self-contained and avoid reorganizing it from the parent repo unless that project is being updated directly
- Use lowercase file names with hyphens for docs where possible
- Keep slugs and doc IDs stable even if the sidebar organization changes
- Add
_category_.jsonwhen introducing a new docs folder so the sidebar stays readable