Review documentation clarity around user/developer pathways/steps
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 33
- Forks
- 19
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 30
Description
### Something else
During the quest there was some ambiguity as a developer whether they needed to follow the developer instructions (developers guide) and also go through the steps of Getting started (including extracting the workflow). This is a placeholder issue to review the documentation and make it really clear what a user needs to do if they are developing only, or using CSET as a released version only.
Contributor guide
No contributing guide indexed for this repository
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 reading the developers guide and Getting started documentation, then compare the steps needed for development-only use with those needed when using a released version of CSET. The work is done when the two pathways and whether each step is required are clearly separated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100