Overview
Adding Documentation
Add or update Scrape Admin guides in the documentation app.
The documentation site lives in apps/docs.
Its Markdown pages are grouped by topic under content/.
Add a page
- Choose the relevant topic folder under
content/, or create a new numbered folder for a new topic. - Add a numbered Markdown file, for example
content/1.getting-started/3.adding-documentation.md. Numbered names control the order in navigation; the filename after the number becomes the page route. - Add frontmatter with a title and description. You can set a navigation icon or title there as well:
--- title: Adding Documentation description: Add a guide to the Scrape Admin docs site. navigation: icon: i-lucide-file-plus --- - Write the guide in Markdown, keeping it focused on Scrape Admin applications, packages, or their usage.
- From the repository root, run the docs app and check the page and navigation:
pnpm --filter @scrape-admin/docs dev
For a new section, add a .navigation.yml file in its folder to set the section title or icon. See the existing
content/1.getting-started/ and content/3.packages/ sections for examples.