Skip to content

docs(site): move documentation under /docs with standard section names - #399

Merged
vishr merged 2 commits into
mainfrom
docs/url-structure
Oct 30, 2026
Merged

vishr merged 2 commits into
mainfrom
docs/url-structure

Conversation

@vishr

@vishr vishr commented Oct 30, 2026

Copy link
Copy Markdown
Member

What changed

Documentation moves from the fanout.run root to /docs, so the root can hold the landing page, blog and pricing. Section and page slugs now use the names most common across developer-tool docs (surveyed from 18 sites' sitemaps): get-started, guides, reference, concepts.

Old New
/start/what-fanout-is /docs/get-started/overview
/start/install, first-boot, send-telemetry /docs/get-started/… (same names)
/guides/set-up-alerts /docs/guides/alerts
/guides/build-dashboards /docs/guides/dashboards
/guides/connect-over-mcp /docs/guides/mcp
/guides/terminate-tls /docs/guides/tls
/guides/tune-retention /docs/guides/retention
/guides/back-up-and-restore /docs/guides/backup-and-restore
/guides/troubleshoot /docs/guides/troubleshooting
/reference/settings/<group> /docs/reference/configuration/<group>
/reference/http-routes /docs/reference/api
/reference/mcp-tools /docs/reference/mcp
/reference/{configuration,endpoints,roles,alert-expressions,data-layout} /docs/reference/… (same names)
/status/capabilities /docs/reference/capabilities
/explanation/why-one-binary /docs/concepts/architecture
/explanation/storage-model /docs/concepts/storage
/explanation/authentication-modes /docs/concepts/authentication
/explanation/performance /docs/concepts/performance

/ and /privacy are unchanged. Old URLs are not redirected and return 404 after deploy.

  • fanout-docgen writes the generated reference pages to the new paths.
  • Product links (ui/links.ts), the README, runbooks, Go code and tests point at /docs; internal/ui/dist is rebuilt.
  • The Collector panel descriptions shorten their link text to stay within the 280-character panel description limit.
  • site/scripts/check-docs-urls.mjs fails the site build if a docs page leaves /docs or loses its Markdown export or llms.txt entry.

Verification

  • just check
  • just test-race when auth, API, ingest, query, MCP, or agent paths changed (not applicable: links and doc paths only)
  • User-facing behavior and configuration docs are current (just docs-generate-check)
  • No credentials, private telemetry, host details, or enterprise-only source are included
  • API, migration, ingest, MCP/AG-UI, or release-contract changes are called out (none; public docs URLs change)

Also: just site-build (32 docs pages, Markdown exports and llms.txt entries verified), lychee over the built site (0 broken links), and a Codex review against main (two stale comments, fixed in 1637be3).

vishr added 2 commits October 29, 2026 15:50
Docs move from the site root to /docs, so the root can hold the landing
page, blog and pricing. Section and page slugs use the names most common
across developer-tool docs: get-started, guides, reference, concepts.
The settings pages become reference/configuration/<group>, HTTP routes
become reference/api, MCP tools become reference/mcp, and the capability
matrix moves from status/ into reference/.

fanout-docgen writes the generated reference pages to the new paths, and
links in the product, README, runbooks and tests point at /docs. The
Collector panel descriptions shorten their link text to stay within the
280-character panel description limit with the longer URL.
check-docs-urls fails the site build if a docs page leaves /docs or loses
its Markdown export or llms.txt entry.
@vishr
vishr merged commit a6a5ae7 into main Oct 30, 2026
17 checks passed
@vishr
vishr deleted the docs/url-structure branch October 30, 2026 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant