Remove the landing page and the docs site - #269
Merged
Merged
Conversation
Documentation is the repository Markdown, read on GitHub. Delete site/ and apps/docs with everything that existed only for them: the root docs scripts, the workspace entry and lockfile importer, the check-docs gate step, the name-allowlist rules for generated guide copies, the build-output ignores and the distribution bundle copy of site/. Links to the deleted docs app README become plain text so the bundled-docs link check keeps passing.
The removed docs app checked that the generated contracts publish exactly the registered routes and that guide sources link to existing files. Keep both guards without the site: - A Go test walks the chi router the server mounts, with every route-gating option, and compares it both ways with core.openapi.yaml (/core/v1) and runtime.openapi.yaml (/api/v1). It also keeps every committed contract path inside its namespace. /healthz, explicit HEAD/OPTIONS 405 guards and the native release content tree are not operations. - The bundled-docs link and anchor check now also runs over every tracked Markdown file outside example/ and provenance/ in make check-distribution. Three links that wrapped across lines now start on one line so the check can read them.
Compare /v1 routes with openapi.yaml as well, so path parameter names match in every namespace. Key route exclusions by method and path and fail when an exclusion matches no registered route. Require the repository Markdown list to include README.md so an empty list cannot pass.
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.
Documentation lives only in the repository Markdown, which readers use on GitHub. This PR deletes the landing page (
site/) and the Fumadocs docs site (apps/docs), along with everything that existed only for them:dev:docs,build:docsandcheck:docsscripts;check-docsMakefile target and its step inmake check;site/copy inscripts/build-core-distribution.sh.In Markdown, only links to deleted files were changed. The docs overhaul PRs remove the prose that still describes the docs site.
Guards kept after the site scripts were removed
services/core/internal/api/contract_routes_test.gowalks the chi router the server mounts, with every option-gated route group enabled. It compares the router in both directions withopenapi.yaml(/v1),core.openapi.yaml(/core/v1) andruntime.openapi.yaml(/api/v1), matching path parameter names exactly. It also checks that every contract path starts with its namespace prefix.GET /healthz, HEAD/OPTIONSmethodNotAllowedguards, and the native-installer download tree/api/v1/agent-daemon/install/*.test_repository_markdown_links_resolvechecks relative links and anchors in every tracked*.mdoutsideexample/andprovenance/. It reuses the bundled-docs checker inscripts/core-distribution-manifest.py. Three links that were split across two lines were rejoined; no words changed.Verification
Only the checks for what this PR touches ran, per the focused-check rule. All passed:
go test ./services/core/internal/api -run '^TestContractsPublishExactlyTheRegisteredCoreAndMachineRoutes$'python3 scripts/core-distribution-manifest.test.py(19 tests)python3 scripts/check-names.pypnpm install --frozen-lockfileandpnpm typecheckmake -n checkbash -n scripts/build-core-distribution.shA full gate started earlier on the same change was stopped partway. Before the stop,
make check(without browser cases),pnpm typecheck,test:core-doctorandtest:webhad passed.Review
A fresh Claude subagent blind-reviewed the full diff. It was given only the requirements, the boundaries, the checkout and the baseline.
/v1parameter names, method-keyed exclusions that must match a route, and a non-empty file list for the link test. All three were fixed inc127e4bband verified with the focused tests, without another review round.example/**is untouched.Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.