Documentation

How to add documentation for your product.


Goal

  • Add documentation pages and categories using Velite.

How docs work

  • Docs are generated by Velite from content/docs.
  • Categories are folders with an index.md file (frontmatter only).
  • Pages are .md or .mdx files with frontmatter.

Add a new doc page

  1. Create a new file under a category, for example: workers/app/content/docs/guides/new-feature.md
  2. Add frontmatter:
---
title: "New Feature"
description: "What it does and why it matters."
order: 3
---
  1. Write your content below the frontmatter.

Add a new category

  1. Create a folder, e.g. workers/app/content/docs/platform/.
  2. Add an index.md with frontmatter only:
---
title: "Platform"
order: 4
---
  1. Add doc pages inside the folder.