docs: link to reference pages instead of restating their content - #164
Merged
Conversation
Follow-up to #162/#163. reference/options.md (and the core reference/ commands, configuration, kit, diagnostics pages) are each area's source of truth. Ran 22 group agents to find spots elsewhere - index pages, guides, recipes, concepts, migration guides - that re-derived an option's shape, default, or mechanics at the same depth the reference page already covers, and replace that elaboration with a short pointer sentence plus a link into the specific reference section. Reference pages themselves were left untouched by design. Every group's edit was checked against its own git diff by an independent verify agent, and I separately validated all 41 newly added links by resolving each target file and confirming the anchor matches a real heading slug. Caught and fixed on top of that: two edits that dropped a fact instead of linking to it (a literal default value, and a two-condition gate mechanism that got flattened into a single, inaccurate condition), plus an em dash and three clause-joining semicolons that don't match this repo's house style. 28 files changed, net -45 lines.
|
…ins.md The de-duplication pass collapsed both into pointer sentences. Keep the tables inline for a walkthrough page like this one, alongside the links to their reference/kit entries.
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
2 participants
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.
🎯 Changes
Follow-up to #162 and #163.
reference/options.md(per plugin/adapter/parser) and the corereference/commands,reference/configuration.md,reference/kit/*.md,reference/diagnostics/*.mdpages are each area's source of truth. Ran 22 group agents to find spots elsewhere — index pages, guides, recipes, concepts pages, migration guides — that re-derived an option's shape, default value, or mechanics at the same depth the reference page already covers, and replace that elaboration with a short pointer sentence plus a link into the specific reference section instead of duplicating it. Reference pages themselves were left untouched by design; several groups (reference-kit, plugin-fetch, several plugin recipes) made no changes at all because there was genuinely nothing left to consolidate.Verification, two layers:
git diffby an independent verify agent.#anchormatches a real heading's VitePress slug, not a guess.Caught and fixed on top of that:
plugin-react-query's migration guide flattened a two-condition gate (hooks: falseskips only theuse*wrappers, factories still emit) into an under-specified single sentence — restored the full mechanism.28 files changed, net -45 lines. Modest by design — most of the corpus already points to its reference page correctly after the previous two passes, so this round found genuine remaining duplication rather than forcing edits everywhere.
✅ Checklist
Generated by Claude Code