curate functions on pkgdown site to improve documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- R
- Stars
- 21
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
Use the user manual classifications: https://nmfs-fish-tools.github.io/SSMSE/manual/intro.html#funs
Some exported functions are not useful to users (they are exported so examples can run, I believe).
How to curate pkgdown reference: https://pkgdown.r-lib.org/articles/pkgdown.html#reference
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 comparing the exported functions with the user manual classifications at the linked manual section, then read pkgdown's reference-curation guidance. Identify which exported functions are intended for users and update the pkgdown reference configuration so it reflects those classifications and omits non-user-facing functions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100