nutanix-cloud-native / nutanix-cloud-native/cluster-api-runtime-extensions-nutanix
Remove markdownlint maximum line length rule
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 17
- Forks
- 12
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 10
Description
We currently have a 120 character maximum line length rule.
While maximum line length make sense for a programming language, I think it makes less sense for prose:
- The docs are written in a text editor, and almost any editor can automatically wrap lines. I don't want to manually wrap lines the first time, or re-wrap lines as I update prose.
- The docs are read in a browser and a text editor. Almost any browser or editor can automatically wrap lines. Manual wrapping can make it more difficult to wrap text automatically for a given viewport size.
I'd like to:
- Remove the rule
- Remove manually-inserted newlines from existing docs
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 with .markdownlint.json and identify the configured 120-character maximum line length rule. Review the existing documentation for manually inserted newlines, remove those wraps, and verify that the rule is removed and the documentation still passes the remaining markdown checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100