For humans

Use the normal HTML site navigation. Pages are split into small topics so you can read one concept at a time.

For automated clients (agents, crawlers, CI)

  1. ManifestGET /docs/manifest.json
    Lists every documentation page with title, repository-relative path, and raw_url (Markdown).

  2. Raw MarkdownGET any raw_url from the manifest. Paths always live under /docs/raw/ (not under /docs/... next to the HTML page). Example:
    http://localhost:4000/docs/raw/scripts/scripting-environment.md
    This is the same source as _docs/ in the repo, with no sidebar or theme.

  3. Why use raw Markdown?
    HTML pages bundle navigation, search, and minified assets. Fetching HTML often truncates or obscures the main content. Markdown gives you the full text in one response.

  4. Scripts — Scripting content is split into three pages: environment, task endpoint, and built-ins. Fetch all three raw files if you need the full scripting reference.

  5. Regeneration_plugins/raw_markdown_mirror.rb writes manifest.json and /docs/raw/** after every jekyll build or jekyll serve. They are not committed under _site/.


Copyright © 2025 Caseblocks Limited.