Website structure

docusaurus rules and requirements document routing always name files/folder with the format nn thefile md prefix dictates file position prefix always starts with 2digits+underscore ( nn , eg 01 somefile md) always use camelcase for file/folder names rely on folder/file names for document ordering note folders will need a category yml that defines a position nn property for them to be correctly ordered use an index md file for declaring a folder's root file we don't use the readme md convention, and the foldername md convention is tricky because of file numbering for order sorting the index md file of a folder should always contain introductory information about the section if the index md file is only a dummy file always add a doccardlist component to the page to make it behave like a generatedindex folders that do not need an introductory page should not add an index md or category yml files reason docusaurus will make the category clickable/expandable with no routing redirection when neither of these files exist document metadata (aka https //docusaurus io/docs/markdown features#front matter ) never add a metadata header to files that do not need it explicit per file metadata is tedious, brittle and very difficult to maintain only give files the sidebar label tag https //docusaurus io/docs/api/plugins/@docusaurus/plugin content docs#sidebar label when the title differs from the desired sidebar name (eg faq vs frequently asked questions) only give files a title tag https //docusaurus io/docs/api/plugins/@docusaurus/plugin content docs#title when the first # title header in the file differs from the desired file title always give a # title to every file, and rely on it for file metadata avoid giving pages a title tag https //docusaurus io/docs/api/plugins/@docusaurus/plugin content docs#title different than its # title unless strictly necessary use filename routing for identifying files eg use /path/to/file instead of id file intro only give files an id tag https //docusaurus io/docs/api/plugins/@docusaurus/plugin content docs#id when other methods of identification would not work never use explicit slug tags https //docusaurus io/docs/api/plugins/@docusaurus/plugin content docs#slug , unless strictly necessary (eg when file path identification does not work correctly)