Skip to content

Site structure

Laura Kalbag edited this page Nov 10, 2022 · 2 revisions

File names and folder structure

Docusaurus uses file names and folder structure to determine its URL structure. So it’s best to choose a good file name and location from the start, to prevent broken URLs in the future!

File names should be simple and hyphen-separated

Do not put docs into subfolders

The docs pages are stored in the /docs folder. We should try to keep as many of the docs inside this flat folder structure (no subfolders) as the file structure determines the URL structure, and reorganizing pages could result in broken URLs in the future. XState-related docs are the exception, and should be kept inside the /xstate folder as their names may clash with other pages.

Clone this wiki locally