-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: updated component max character / max word counts #1184
Conversation
|
✅ Deploy Preview for red-hat-design-system ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Size Change: 0 B Total Size: 210 kB ℹ️ View Unchanged
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think these tables need a sentence or two of prose before them to explain what they're all about
@bennypowers there should be text preceding all of the tables. Some of it existed before this PR. PTAL |
…o docs/max-character-limits
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we say, "The recommended maximum character count..."?
Also in a caption under each table, can it say, "The character count includes spaces"? (I don't think the <rh-tile>
page needs this though, since it says basically the same thing above the table.)
@marionnegp ptal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes are looking good!
- Didn't notice this last time, but on Audio Player's page, the first column header is "Tab count." Is that right?
- Do you think it's valuable to add a sentence about how the character count includes spaces? I was thinking it could be a caption under the tables.
@marionnegp ptal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Local Grandma Tramples Musician
What I did
Worked with @coreyvickery to determine which components/parts of components should max character counts in the guidelines pages of docs, and added to or updated docs accordingly:
Testing Instructions
Notes to Reviewers