fix(routes): make docs root canonical - #97
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
nibzard
marked this pull request as ready for review
July 30, 2026 16:59
This was referenced Jul 30, 2026
nibzard
added a commit
that referenced
this pull request
Jul 31, 2026
…103) The `.md suffix end-to-end` suite boots `next dev --turbopack` via `bunx` and tears it down with `server.kill(); await server.exited`. `kill()` only SIGTERMs the direct bunx child; the next-server/Turbopack grandchildren survive, so `.exited` never resolves and afterAll blocks until Bun's setDefaultTimeout(120000) -- failing the file and turning CI red on every run since PR #97 (the fragility was latent since the teardown landed in PR #81). PR #102 (timeout-minutes: 30) does not help: that bounds the GitHub job timeout, but the job finishes in ~3-6 min and the 120s is Bun's per-hook timeout, a different layer. Spawn the dev server detached so it leads its own process group, then tear the whole group down: SIGTERM, race `.exited` against a 3s budget, escalate to SIGKILL if it hasn't exited. The awaited exit is now bounded, so teardown can no longer hang regardless of how the child handles SIGTERM -- and the full tree is reaped, keeping the port/CPU free for the later Chromium tests. Validated: bun run typecheck, biome check, and bun test tests/e2e/llm-endpoints.test.ts (22 pass). Co-authored-by: Claude <noreply@anthropic.com>
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
1 participant
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
//overviewpath to//overview/*documentation namespace unchanged/invariant HTML for browsers, crawlers, user-directed agents, and MarkdownAcceptrequests/overviewinternal linkWhy
The docs root was a routing shim: middleware either rewrote
/to/AGENTS.mdor redirected it to/overview. That made the natural homepage URL behave differently by request class and treated a non-equivalent agent guide as the Markdown representation of the homepage.Making
/the real homepage gives every client one canonical, indexable HTML entry point. The permanent exact-path redirect preserves existing/overviewlinks without disturbing the established nested documentation URLs.Impact
https://docs.steel.dev/becomes the canonical homepage and appears once in the sitemap.https://docs.steel.dev/overviewcontinue to work through a308redirect./overview/do not move./AGENTS.md,/llms.txt, explicit.mdURLs, and regular docs negotiation keep their existing behavior.Validation
bun run check --error-on-warningsbun run typecheckbun run validate-linksbun run buildbun test tests/markdown-negotiation.test.ts tests/middleware.test.tsbun test tests/e2e/llm-endpoints.test.ts— 19 passedgit diff --checkbun test: 288 passed; one unrelated image-generation integration test hit the global 120-second timeout. The exact timed-out test passed immediately on isolated retry in 485 ms.