Enforce a consistent markdown style thoughout the document
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 112
- Forks
- 38
- Avg merge
- 12d 19h
- Merged PRs (30d)
- 4
Description
Currently we have a wild variety of markdown styles thoughout the document:
- IETF-style 80 characters per line
- one sentence per line
- one paragraph per line
I propose to adapt the whole spec for style number 2, as it offers the best review capabilities. Making and reviewing changes with option 1 is terrible and Github UI is not able to mark green/red sections for changes if lines get too long (option 3).
Secondly, we should enforce proper markdown rules for every PR.
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 locating the specification document and the existing pull-request validation setup. Review the current line-break patterns and any Markdown checks before applying the agreed one-sentence-per-line style. Done means the whole specification follows that style and pull requests enforce the documented Markdown rules.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100