docs: rearchitect API reference into grouped multi-symbol pages#3205
Open
bartlomieju wants to merge 2 commits into
Open
docs: rearchitect API reference into grouped multi-symbol pages#3205bartlomieju wants to merge 2 commits into
bartlomieju wants to merge 2 commits into
Conversation
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.
The API reference generated one page per symbol (~11,000 thin pages), which
hurt SEO, scattered feedback issues across stray property pages, and made
the reference hard to browse. This regroups the @deno/doc output into ~95
pages — one per Deno/Web category and per Node module — with every symbol
documented inline under a stable anchor, in the spirit of bun.com/reference.
The landing pages become dense find-in-page-friendly symbol indexes, /api/
becomes a tile hub, and the hand-written guides move to /api//about/.
Every old per-symbol URL 301s to its exact anchor via a generated redirect
map (11k entries, served by the redirects middleware), cross-symbol links
are rewritten to the new anchors, and ~330 dead links that silently shipped
before are now logged at build time. Orama search documents point at the
new anchored URLs, and all reference pages now carry titles, descriptions,
and sitemap entries. Also includes a small inert prototype
(/api/preview/node-http/, built only when its raw doc-node input exists
locally) exploring a prose-first renderer fed by raw deno doc --json output
as a possible next step.