oasisprotocol / oasisprotocol/docs
Linter for general and network-primer docs
Open
Nobody has claimed this yet.
ci
p:2
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
Add markdown linter for general and network-primer docs. At least the line lengths are currently not enforced so this might require some manual labour.
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 locating the general and network-primer documentation, then inspect how documentation checks are currently configured. Define the markdown rules to enforce, including line lengths, and verify that both documentation areas pass the linter after any required cleanup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100