Repository navigation
docs(upgrading): split the v2-to-v3 guide by area under an index page - #475
Merged
Merged
Conversation
Contributor
File size check0 over a hard cap (fails), 9 warning(s).
Split the file, wrap the line, shorten or exempt the comment, or list the path in 5 managed file(s) skipped; repo-platform owns them. |
Vivswan
marked this pull request as ready for review
October 5, 2026 12:44
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The library-section count is outdated, and the moved intentional typo is no longer allowlisted for the typography gate.
Review effort: Balanced
Findings: 1
Open (2)
What changed in this PR
Splits the v2-to-v3 upgrade guide into a concise index and eight focused area pages.
Changes:
- Groups all 61 migration sections by subject.
- Preserves section anchors and updates cross-page links.
- Repoints the documentation assertion to the moved content.
| File | Description |
|---|---|
docs/upgrading/v2-to-v3.md |
Becomes the grouped index and summary. |
docs/upgrading/v2-to-v3/run.md |
Covers run inputs and outputs. |
docs/upgrading/v2-to-v3/settings-file.md |
Covers settings-file directives. |
docs/upgrading/v2-to-v3/layering.md |
Covers layering and rendering. |
docs/upgrading/v2-to-v3/sections.md |
Covers per-section behavior. |
docs/upgrading/v2-to-v3/refusals-repository.md |
Covers repository-level refusals. |
docs/upgrading/v2-to-v3/refusals-lists.md |
Covers list-section refusals. |
docs/upgrading/v2-to-v3/library.md |
Covers library API migrations. |
docs/upgrading/v2-to-v3/releases.md |
Covers releases and tags. |
test/docs/guides.test.ts |
Reads the moved validation example. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The guide sat at 1298 lines, two under the fleet's 1300-line cap on a markdown file, so the next break section could not land. Every numbered section moves verbatim to one of eight area pages under docs/upgrading/v2-to-v3/, keeping its number, title, and anchor; the index page keeps the intro, the summary table grouped by area, and the order of operations. Links that now cross pages gain their page. Two corrections ride along because the index is rewritten: the intro count reads sixty-one, and the summary table gains the row for section 61, which the base commit added without one. The one test that read the guide by path now reads the page that holds section 2.
…robe cap The two paragraphs the docs probe flagged (110 and 263 words) become five bullets with bold lead-ins, and a grammar table with the two output lines quoted in text fences. Every fact is kept; the probe reports all nine pages clean.
Vivswan
force-pushed
the
docs/upgrading-split
branch
2 times, most recently
from
October 5, 2026 13:03
5a2c7c9 to
ee2e2e0
Compare
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.


What this changes
One summary row, before and after:
How
../link gains a level.docs/recursively, so one path change covers the new pages.Proof
##headings 62 -> 70.Technical details
test/docs/guides.test.ts, thereadFileSyncpath in the wrapper-key fence assertion, repointed todocs/upgrading/v2-to-v3/settings-file.md.[type.layering-guide]glob in_typos.tomlgainsrefusals-lists.md, the page the split moved the quoteddeclares "permision"refusal to, since typos matches type globs by file name only.DiscoveryFilters.excludefor library callers), and the missing summary row for section 61, which the base added without one.textfences; every fact kept.##headings added; the 62 old ones are kept with their text.../../links resolve (the anchor test).title, since two carry a colon.docs/upgrading/v2-to-v3.md+98 -1254; the eight pages +1302 -0;test/docs/guides.test.ts+1 -1;_typos.toml+5 -4; total +1406 -1259.docs/upgrading/v2-to-v3.md,docs/upgrading/v2-to-v3/{run,settings-file,layering,sections,refusals-repository,refusals-lists,library,releases}.md,test/docs/guides.test.ts,_typos.toml.