Skip to content

docs: split Upgrades off the Versionierung page - #3064

Open
mfal wants to merge 4 commits into
mainfrom
claude/rename-versionierung-docs-88bd50
Open

docs: split Upgrades off the Versionierung page#3064
mfal wants to merge 4 commits into
mainfrom
claude/rename-versionierung-docs-88bd50

Conversation

@mfal

@mfal mfal commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

  • Reverted the earlier rename — the page stays Versionierung & Stabilität / Versionierung.
  • Split the upgrade-workflow content off into a new /get-started/upgrades page: the migration-guide pointer, the codemod CLI section, deprecation-warning guidance, and the post-release npm version-mismatch window. Versionierung keeps the semver contract itself (what's guaranteed, Node/React support, lifecycle status).
  • Cross-linked the two pages, and updated the existing references in installation, align, and segmented-control to point at whichever of the two now actually covers that content.
  • Links Upgrades from the Releases page's intro paragraph (both the rendered page and its shadow MDX used for search/llms.txt), so readers landing on release notes know where to find the upgrade how-to.

Test plan

  • pnpm nx test:links docs — passes
  • pnpm nx build docs (full production build) — passes; verified /get-started/upgrades is generated, TypeScript compiles, and the split content lands on the right page in the built HTML
  • prettier --check on the touched files — passes

The page already covers upgrading (codemod CLI, migration guide links,
deprecation warnings) beyond just semver rules. Update its title/navTitle
and the three cross-reference link texts pointing at it accordingly.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mfal
mfal requested a review from a team September 1, 2026 14:26
@mfal mfal self-assigned this Sep 1, 2026
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Coverage Report for ./packages/components/

Status Category Percentage Covered / Total
🔵 Lines 78.69% 746 / 948
🔵 Statements 78.57% 763 / 971
🔵 Functions 80.09% 165 / 206
🔵 Branches 70.33% 377 / 536
File CoverageNo changed files found.
Generated in workflow #6514 for commit fa67aea by the Vitest Coverage Report Action

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview Deployment

Preview environments are ready:

Type URL
docs pr-3064.docs.review.flow-components.de
storybook pr-3064.storybook.review.flow-components.de

Images:

  • docs: ghcr.io/mittwald/flow/docs:pr-3064
  • storybook: ghcr.io/mittwald/flow/storybook:pr-3064

The versioning page mixed two concerns: the semver contract (what's
guaranteed, lifecycle status) and the upgrade workflow (migration
guides, the codemod CLI, deprecation warnings, the post-release npm
version-mismatch window). Split the latter into a new /get-started/upgrades
page and cross-link the two, updating references elsewhere accordingly.

Also links Upgrades from the Releases page's intro paragraph, so readers
land on release notes and know where to find the how-to for applying them.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mfal mfal changed the title docs: rename Versionierung page to Versionen & Upgrading docs: split Upgrades off the Versionierung page Sep 1, 2026

@Jan-Eimertenbrink Jan-Eimertenbrink left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Mini: Versionierung sollte im Get Started Menü über Upgrades stehen

Both pages were unlisted in CONTENT_ORDER, so the sidebar sorted them
alphabetically by label — Upgrades before Versionierung. Author the full
Get Started child order explicitly instead (all-or-nothing per
contentOrder.node.test.ts), putting Versionierung ahead of Upgrades per
review feedback on #3064.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@mfal

mfal commented Sep 1, 2026

Copy link
Copy Markdown
Member Author

Fixed — Get Started now sorts explicitly (Installation, Stylesheet, Versionierung, Upgrades) via CONTENT_ORDER instead of falling back to alphabetical, so Versionierung shows above Upgrades in the sidebar.

🤖 Addressed by Claude Code

1 similar comment
@mfal

mfal commented Sep 1, 2026

Copy link
Copy Markdown
Member Author

Fixed — Get Started now sorts explicitly (Installation, Stylesheet, Versionierung, Upgrades) via CONTENT_ORDER instead of falling back to alphabetical, so Versionierung shows above Upgrades in the sidebar.

🤖 Addressed by Claude Code

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.

2 participants