SciML / SciML/ModelOrderReduction.jl
Improve documentation
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 43
- Forks
- 8
- Avg merge
- 11h 47m
- Merged PRs (30d)
- 14
Description
Such that makedocs warnonly = [:missing_docs, :example_block] can be removed.
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 with the documentation build configuration around makedocs and identify every missing_docs and example_block warning. Run the documentation build to inventory the warnings, then update the relevant documentation or examples until the build passes without warnonly; completion means that option can be removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100