Skip to content
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

Improve accessibility of notes #2795

Merged
merged 1 commit into from
Apr 26, 2017

Conversation

joaofnfernandes
Copy link
Contributor

Extends #2710 to
fix #2784

Copy link

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

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

There is still nothing added to Important. The others are looking great!

@joaofnfernandes
Copy link
Contributor Author

I don't understand the feedback. Can you detail or add a screenshot?

@mdlinville
Copy link

When I checked in /test in netlify I did not see the "Important:" on the important note. Let me double check.

@mdlinville
Copy link

color: $warning-color;
}

blockquote.warning > p:first-child::before {
content: 'Be careful: ';

Choose a reason for hiding this comment

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

Oh I see. Is this the prefix we want to use?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm using the warning and danger classes, since other front-end frameworks like bootstrap use classes like that with the same semantics.

@joaofnfernandes
Copy link
Contributor Author

It the PR as is right now, you have 3 messages if you use two paragraphs in the blockquote style

screen shot 2017-04-18 at 14 13 30

@mdlinville
Copy link

Yes, I just don't like the Be careful. I do not think it aligns with admonition conventions that readers will have learned to understand, which tend to use words like Important or Caution or Info to denote severity level. I don't think we need to buck well-established trends.

@joaofnfernandes
Copy link
Contributor Author

@mstanleyjones I know that there are a few docs out there that converged in a common terminology but I don't think they are well established trends. They are mostly conventions developed by older docsets. If you look at the new kids in the block, they have very few notes/warnings, and tend to only have a single style for them.

I'm shooting for a compromise between fun and accessibility. We're the fun side of enterprise 🐳

@joaofnfernandes joaofnfernandes force-pushed the 2784_notes_improvement branch from 3e829e7 to 6198dbb Compare April 25, 2017 17:57
@joaofnfernandes
Copy link
Contributor Author

@mstanleyjones the feedback was addressed. If you're ok merge this and label #2784 as counted.

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.

Improve note accessibility
4 participants