CDCgov / CDCgov/forecasttools

Organize function reference

Open
#159 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
5
Forks
2
Avg merge
2d 6m
Merged PRs (30d)
7

Description

Add some structure so that it is more navigable (rather than a flat list)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the function reference that is currently presented as a flat list and inspect how the project organizes its other documentation. Group the reference into a more navigable structure, with completion indicated by the functions being easier to browse than the current flat list.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.