Repository navigation
docs: move documentation under /docs with standard section names - #230
Merged
Merged
Conversation
Docs move from the onebox.run root to /docs, so the root can hold the landing page. Sections use the names most common across developer-tool docs: get-started, guides, reference, concepts. Generic guide slugs become the common nouns (databases, backups, secrets, rollback, migrations, cron-jobs, environment-variables), the capability matrix moves from status/ into reference/, and /docs gets a documentation home. The site builds with format "preserve", so Starlight's links carry no .html; the route middleware still corrects the canonical, and check-docs-urls fails the build on a .html link or a docs page without its Markdown export or llms.txt entry. ob-docgen writes the reference pages to the new paths, and the CLI's install remedy links to /docs/get-started/install. Old URLs are not redirected.
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 this changes
Documentation moves from the onebox.run root to
/docs, matching labstack/fanout#399 and #402. Sections and generic page slugs use the names most common across 18 surveyed developer-tool docs sites./start/what-onebox-is/docs/get-started/overview/start/{install,first-deploy,reading-it-back}/docs/get-started/…(same names)/guides/add-a-database/docs/guides/databases/guides/adopt-compose/docs/guides/compose/guides/back-up-a-database/docs/guides/backups/guides/deploy-through-a-jump-host/docs/guides/jump-host/guides/handle-secrets/docs/guides/secrets/guides/roll-back/docs/guides/rollback/guides/run-migrations/docs/guides/migrations/guides/schedule-a-job/docs/guides/cron-jobs/guides/{eject,environment-variables,upgrade-to-onebox-names}/docs/guides/…(same names)/reference/…(includingfields/*)/docs/reference/…(same names)/status/capabilities/docs/reference/capabilities/explanation/…/docs/concepts/…(same names)/docsis a new documentation home with the quickstart path and the four sections; the header Docs link points at it.build.format: "preserve", so Starlight's sidebar, previous/next and title links carry no.html. The route middleware still corrects the canonical.ob-docgenwrites reference pages to the new paths. The CLI's Docker and Compose install remedy (internal/app/prerequisites.go) now links to/docs/get-started/install.docs/decisionsanddocs/planskeep their original paths.Why this is correct
check-docs-urlsfails the site build if a docs page leaves/docs, lacks its Markdown export orllms.txtentry, or links to a.htmlpath; a probe with an injected.htmllink was rejected.check-canonicalconfirms canonical,og:urland the sitemap agree for 44 pages.context7.json.Effect on the safety envelope
None. Documentation URLs and one remedy link change; no runtime behaviour does.
Checklist
just checkpasses locally.check-docs-urls, Markdown conversion tests, docgen tests).just checkverifies this).