SciML / SciML/ModelingToolkitStandardLibrary.jl
Improve documentation
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 171
- Forks
- 49
- Avg merge
- 15h 50m
- Merged PRs (30d)
- 10
Description
Such that makedocs warnonly = [:docs_block, :missing_docs, :cross_references] 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 by running makedocs and inspect the reported docs_block, missing_docs, and cross_references warnings. Identify the documentation sources responsible for each warning; done means the warnings are resolved so the listed warnonly entries 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
- 25/100