Back to Docs/Getting Started

Getting Started

Quick overview of how to add and view documentation within the app.

Docs Overview

Welcome to the OpenPond docs space. Everything you add under lib/docs/content shows up automatically inside the public /docs route.

Adding Content

  1. Create or copy any .md file into lib/docs/content.
  2. Optionally add front matter like this:
    md
    --- title: Example Title description: Short summary for the sidebar. order: 2 group: Ops ---
  3. Commit the file. Next build will pick up the new page.

Navigation

  • Folders inside lib/docs/content become nested sections in the sidebar (e.g., lib/docs/content/ops/runbooks/alerts.md -> /docs/ops/runbooks/alerts).
  • order controls sorting among siblings inside the same folder.

Copy For LLMs

Every page ships with a "Copy page for LLM" button so you can grab the raw markdown without leaving the site.

Happy documenting!