Admonition Fatigue
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 32
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Description
Just a bit of friendly feedback, I find the admonition use in the book a bit challenging to read.
I've heard the idea of 'admonition fatigue' passed around, to me an admonish reads a bit like SHOUTING. WHEN EVERYTHING IS CAPITAL LETTERS IT GETS NOISY, ESPECIALLY WHEN THE CONTENT IS VERY LONG OR JUST A LINK OR SOMETHING THAT DOES NOT REQUIRE EMPHASIS (im not actually shouting here 🙃)
Love the idea of spicing mdbook up with color, it has great theming support, could be a oneshot prompt to replace the admonishments with something more legible but equally pretty.
Just my personal experience, thanks for the awesome library!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the book's current admonition usage and the mdBook theme documentation linked in the issue. Determine which long, link-only, or low-emphasis admonitions need different treatment; done means the book remains colorful and legible without making routine content feel like shouting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, markdown
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100