Inconsistent formatting of register section titles
Open
awaiting feedback
consistency - style
content
good first issue
- Dominant language
- Markdown
- Stars
- 783
- Forks
- 134
- Avg merge
- 6h 54m
- Merged PRs (30d)
- 3
Description
- [ ] Settle on an overall format
- [ ] Decide how to format "R/W"
- [ ] Decide on how to format compat info
Original OP below.
---
#124 changed the register anchor format from `ADDR - NAME - Descr (R/W)` to `ADDR - NAME (Descr) (R/W)`, but the old style is still present elsewhere (e.g. `IF` still uses it).
Which format do we want to settle on (not necessarily either of these)?
Contributor guide
Research direction
Review the register section titles changed by #124 and compare the remaining older style, including the IF section. First map the existing formats for addresses, descriptions, R/W markers, and compatibility information. Done means agreeing on a single format and applying it consistently across the affected documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100