Skip to content

docs: move (since vNEXT) tags out of markdown headings - #697

Merged
padak merged 1 commit into
mainfrom
docs/vnext-out-of-headings
Aug 25, 2026
Merged

docs: move (since vNEXT) tags out of markdown headings#697
padak merged 1 commit into
mainfrom
docs/vnext-out-of-headings

Conversation

@padak

@padak padak commented Aug 25, 2026

Copy link
Copy Markdown
Member

Why

CONTRIBUTING.md forbids version tags in markdown headings: the anchor slug is derived from the full heading text, so when the release PR resolves vNEXT to the real version, the slug changes and every inbound link to that section silently breaks (this bit 0.90.0).

What

Moves the (since vNEXT, ...) tag from four headings onto each section's first body line as *(since vNEXT, ...)*, matching the pattern PR #691 applied to gotchas.md:

The serve --config-dir heading fix is byte-identical to the one on the open PR #691 branch, so the two merge cleanly in either order.

Verified: no ^##.*vNEXT headings remain anywhere under plugins/, and no inbound links reference the changed anchor slugs.

Docs-only: no version bump, no changelog entry (per the release process -- feature/docs PRs never bump).


Open in Devin Review

Moves the (since vNEXT) tags out of four section headings -- the
workspace-workflow.md load-types section plus three gotchas.md entries
from #695, #692 and #681 -- onto each section's first body line, so the
heading anchor slugs stay stable when the placeholder resolves at
release. Same fix pattern as PR #691; the serve --config-dir heading is
changed byte-identically to that branch so the two merge cleanly in
either order.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@padak
padak merged commit 0625299 into main Aug 25, 2026
4 checks passed
@padak
padak deleted the docs/vnext-out-of-headings branch August 25, 2026 13:20
@padak padak mentioned this pull request Aug 25, 2026
13 tasks
padak added a commit that referenced this pull request Aug 25, 2026
Bump pyproject to 0.91.0, add the changelog entry covering every PR merged since v0.90.1 (#627, #681, #691, #692, #693, #694, #695, #696, #697, #698), resolve all 54 vNEXT version-gate placeholders, and run version-sync + skill-gen.

No web/frontend changes in this batch, so no whatsnew.ts entry.
padak added a commit that referenced this pull request Aug 25, 2026
CONTRIBUTING.md release step 4 keeps version tags off headings: resolving the
placeholder changes the generated anchor slug and breaks inbound links. PR #697
did this pass, but #694 and #696 landed their headings around the same time and
fell outside its grep.

- gotchas.md: two headings, tag moved to the section's first body line
- sync-workflow.md: heading reworded to 'Migrating a legacy sync tree', with
  the version stated on a body line

No inbound links reference the affected anchors (verified by grep).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant