docs: restructure runtime docs by reader intent#3190
Open
bartlomieju wants to merge 5 commits into
Open
Conversation
4304815 to
7d2264c
Compare
…ink, disambiguate Deno 1.x→2.x migration
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.
The runtime sidebar grouped pages under "Fundamentals" and "Reference
guides", but the split was inconsistent: the same topic was scattered
across both groups (TypeScript, testing, linting, and HTTP each appeared
twice), and "Reference guides" was mostly how-to content sitting next to
genuine reference. A reader could not predict which group to check for a
given topic.
This regroups the runtime docs by what the reader is trying to do — Get
started, Guides, Concepts, Advanced, and Reference. Guides is kept to a
short list of high-traffic tasks so it stays scannable and does not bury
Concepts; the long tail of how-tos moves to Advanced. The top-bar "Docs"
link is renamed "Runtime" (Examples and the API reference are docs too),
and the lint-rule catalog gets a Reference link so it is no longer
reachable only via search.
The regrouping itself changes no page URLs. On top of it, the dependency
management content (adding, versioning, overriding, vendoring, lockfiles,
supply chain, publishing, private registries) moves out of the Modules
concept into a new Dependency management guide, so the Modules page is a
lean concept and the guide is a task-oriented reference. It keeps the
relevant oldUrl redirects, and inbound links are updated to the new
location.