leanprover-community / leanprover-community/physlib
Add documentation linters to PhyslibAlpha.
Open
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 750
- Forks
- 191
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 75
Description
Within Physlib, we have optional linters for documentation. These should be turned on and enforced strictly in PhyslibAlpha, given the other weaker controls on review that we have in place there. This task is really down to:
- identifying what those documentation linters are
- adapting them to PhyslibAlpha
- making sure that they are turned on automatically in the GitHub workflow for PhyslibAlpha
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 optional documentation linters already used in Physlib and the GitHub workflow for PhyslibAlpha. Adapt the existing linter configuration for PhyslibAlpha, then verify that the linters run automatically and strictly in its workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100