docs: add styleguide content guidelines and align docs content#2615
Open
Lisa18289 wants to merge 7 commits into
Open
docs: add styleguide content guidelines and align docs content#2615Lisa18289 wants to merge 7 commits into
Lisa18289 wants to merge 7 commits into
Conversation
Contributor
Coverage Report for ./packages/components/
File CoverageNo changed files found. |
Contributor
🚀 Preview DeploymentPreview environments are ready:
Images:
|
…e-guide-guidelines-readme-to-github
auto-merge was automatically disabled
July 10, 2026 05:51
Pull request was converted to draft
- Overhaul apps/docs README: document content language (German), the two tone modes (objective descriptions, imperative instructions), heading rendering and page structure, real tab section structures, MDX building blocks, and QA steps - Standardize headings: Behavior -> Verhalten, Writing guidelines casing and levels, sentence case for Responsive layout - Write "Komponente" instead of "Component" in German prose (code, token names, and proper terms stay English) - Move the CounterBadge accessibility note from Overview to Guidelines - Reorder Button overview: States before Kombiniere mit ... - Fix content bugs: broken navigation link, typos, bold code identifiers Co-Authored-By: Claude Fable 5 <[email protected]>
Co-Authored-By: Claude Fable 5 <[email protected]>
Best practices -> Best Practices, Responsive layout -> Responsive Layout, Quick submit -> Quick Submit, Progressively disclosed Form Controls -> Progressively Disclosed Form Controls; document the title-case rule in the README (German headings keep regular German orthography) Co-Authored-By: Claude Fable 5 <[email protected]>
Add apps/docs/AGENTS.md pointing agents to the content guidelines in apps/docs/README.md, and link it from the root AGENTS.md lookup table Co-Authored-By: Claude Fable 5 <[email protected]>
Lisa18289
changed the title
Lisa18289
requested review from
Jan-Eimertenbrink,
ins0,
maaaathis and
mfal
as code owners
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
1 participant
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.
No description provided.