void-linux / void-linux/void-docs
Use bolding only for warnings?
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 217
- Forks
- 212
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 1
Description
As discussed at #297 (e.g. this comment by @ericonr), i think it would be good to draw readers' attention to warnings via bolding. However, to ensure a consistent meaning for bolding, i think it should perhaps only be used in such cases, rather than to e.g. introduce terms, as in #177, where emphasis via *term* could be used instead.
(However, i don't think this issue should be considered a blocker for #177.)
Contributor guide
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 issue #297, the linked comment by @ericonr, and issue #177 to understand the proposed meaning of bold and emphasis in the documentation. Identify the affected documentation usages, agree on a consistent warning-only policy, and update the relevant Markdown content once the scope is settled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100