Repository navigation
docs(site): move documentation under /docs with standard section names - #399
Merged
Merged
Conversation
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.
This was referenced Oct 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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./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/privacyare unchanged. Old URLs are not redirected and return 404 after deploy.fanout-docgenwrites the generated reference pages to the new paths.ui/links.ts), the README, runbooks, Go code and tests point at/docs;internal/ui/distis rebuilt.site/scripts/check-docs-urls.mjsfails the site build if a docs page leaves/docsor loses its Markdown export orllms.txtentry.Verification
just checkjust test-racewhen auth, API, ingest, query, MCP, or agent paths changed (not applicable: links and doc paths only)just docs-generate-check)Also:
just site-build(32 docs pages, Markdown exports andllms.txtentries verified),lycheeover the built site (0 broken links), and a Codex review againstmain(two stale comments, fixed in 1637be3).