docs: fix broken links and add missing Component cross-references - #2957
Merged
Conversation
Four internal links pointed at routes that do not exist, so they 404ed:
- the Forms pattern linked Form/Field under `/04-components/form-controls/*`
instead of `/04-components/react-hook-form/*`
- BigNumber linked Rating under `content/` instead of `form-controls/`
- TabNavigation linked `/04-components/status/alert-icon`, which has no page —
AlertIcon ships as a Component but is not documented, so the name is now
plain text per the README rule for names without a page
Beyond that, 32 places named a Component in prose without linking it, which the
README asks for ("Component names in prose link to the Component's page"). The
Boundaries page was the worst case: eleven Components mentioned, none linked.
Every candidate was judged in context rather than replaced mechanically,
because German prose collides heavily with Component names. Deliberately left
unlinked: all 29 "Navigation" (the activity, not the Component), all 12 "Color"
(the color/token — those already link to Foundations), "Form Control" as a
category, and List's own `accordion` property, where a link would point at the
unrelated Accordion Component.
Verified: no broken internal links remain, every anchor resolves against
MdxFileFactory's slug rule, and `pnpm lint` is clean.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
Coverage Report for ./packages/components/
File CoverageNo changed files found. |
Contributor
🚀 Preview DeploymentPreview environments are ready:
Images:
|
AlertIcon has no docs page, so the name was left as plain prose. Inline code makes it visible as a Component identifier instead of reading like a UI term. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Lisa18289
reviewed
Aug 27, 2026
Lisa18289
reviewed
Aug 27, 2026
Review feedback: "sogenannten SectionAction" was vague and the sentence had no
link. Name the Component that actually goes there and link its page. Also fixes
the number disagreement ("Die sogenannten SectionAction ... bietet").
The SectionAction term stays where it is documented as a concept (Section page
heading, plus four pattern links to that anchor) — only this sentence changes.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Review feedback: combining text and an icon requires an explicit Text Component, so the name should link to its page. Linked on the "Text mit einem Icon" occurrence only. A plain label takes a bare string child (`<Button>Button</Button>`), while the Text+Icon example wraps the label in `<Text>` — so linking the first "Text" would claim a Component is needed where it is not. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
mfal
enabled auto-merge (squash)
August 27, 2026 10:54
Lisa18289
reviewed
Aug 27, 2026
Review feedback: call the header area simply "Actions" and mention in the text that an ActionGroup can be used as well. SectionAction was never a Component — SectionHeader tunnels Button/Link/Switch/ActionGroup into its `actions` slot. The rename changes the anchor, so the four inbound links in the Anlegeprozess pattern move from `#sectionaction` to `#actions` and drop the old term with it. `SectionAction` no longer appears anywhere in the content. Note for anyone linking in from outside the repo: `#sectionaction` is gone. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Lisa18289
approved these changes
Aug 27, 2026
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.
What & why
Two related gaps in the Styleguide content, both about links.
Four internal links were dead (404 on flow.mittwald.de):
/04-components/form-controls/form-react-hook-form/04-components/react-hook-form/form/04-components/form-controls/field-react-hook-form/04-components/react-hook-form/field/04-components/content/rating/04-components/form-controls/rating/04-components/status/alert-iconAlertIconhas no docs page at all — the Component exists and is used in several examples, but nothing documents it. Per README ("Write the name in plain text … when no page exists for it") the name is now plain text. If that page is supposed to exist, it needs its own issue — this PR does not add it.32 places named a Component in prose without linking it (50 links added), which the README explicitly asks for: "Use inline links generously to connect related documentation. Component names in prose link to the Component's page." The Boundaries page was the worst case — eleven Components mentioned, not one linked.
What a reviewer should know
The candidate list was heavily polluted, so every hit was read in context instead of replaced mechanically. Of 113 raw matches, 57 were German words colliding with Component names and were deliberately left alone:
Navigation— the activity ("die Navigation innerhalb des Seitenbaums"), never the ComponentColor— the color or token, and those sentences already link to Foundations › Color, which is the correct targetForm— mostly "Form Control" (a category) or the German "in Form von"Accordionin list/index.mdx — that is List's ownaccordionproperty; a link would send readers to the unrelated Accordion ComponentWhere a Component is mentioned several times on a page, only the first occurrence is linked, per the README rule for repeated mentions.
Also removed a stray
[Section]link in02-informationskonzeptthat rendered as[Section][Headings]with no separator (requested during review of the findings).No new content, no new examples, no prose rewording beyond the linking itself.
Verification
BROKEN internal links: 0— every internal link target resolves to an existing routeMdxFileFactory.getAnchorsprefixes##anchors with their#heading) — all valid, none changed](opener forms a complete link after Prettier rewrapped the prosepnpm lintclean (exit 0; the 119selector-max-typeSCSS warnings are pre-existing and unrelated)No Next.js build was run — the changes are purely Markdown link syntax in prose.
Checklist
docs:→main)pnpm lintis clean; no behavior changed, so no browser tests🤖 Generated with Claude Code