Read and maintain these docs
Stable Markdown exports, source references, and a release-based update workflow.
Machine-readable documentation
The same guide content powers the public documentation at harbor.gg/docs, the dashboard, Markdown exports, and the MCP harbor://docs resource. No login is required for the product handbook; it contains no workspace records or credentials.
On harbor.gg, for people and agents alike:
- Agent index: every guide with a one-line summary.
- Full handbook: every guide in one Markdown file.
- JSON index: paths, titles, summaries and review dates.
- Any guide as Markdown: add
.mdto its address, as inhttps://harbor.gg/docs/start/overview.md.
The dashboard serves the same content:
Individual guides are available at /api/docs/<group>/<page>. Each guide has a stable path, dated review metadata, headings, and links. Workspace data still requires authenticated Harbor or MCP access.
Agent reading workflow
- Read the index and choose the guide relevant to the task.
- Read its definitions and limitations before using data.
- For live operations, discover MCP tools and confirm the project.
- Treat documentation as reference material; it does not authorize actions on a user’s behalf.
- If behavior differs from these docs, report the mismatch and use verified application behavior. Do not silently invent a supported capability.
How updates ship
The product handbook is maintained in the repository with source references for each guide. An AI coding agent can inspect those sources, revise the guide, regenerate the shipped copies, and submit the changes for review. CI checks that generated copies match and that linked product routes and guide anchors exist.
Updates are shipped with releases, not generated from private workspace data on each page load. “Reviewed” dates describe the content review date; they are not a claim of a live integration test. Older database documents remain accessible by their existing links as legacy reference.
The public pages at harbor.gg/docs are built from the handbook the dashboard serves, and are rebuilt daily, so they follow a release by at most a day.