Add developer guide to documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 8
Description
The documentation should include a developer guide, alongside the user guide.
This should start by migrating the developer information (Working Practices, Developer Guide, Review Process) from the wiki into the documentation.
Developer guidance should reflect that some developers only need to add/update ESMValTool recipes, and don't need to know how to develop the core CMEW infrastructure. The structure of the guidance should align with Diataxis framework.
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 reviewing the existing Working Practices, Developer Guide, and Review Process material in the wiki, then inspect the current documentation alongside the user guide. Organize migrated guidance using the Diataxis framework and distinguish recipe contributors from core CMEW developers. Done means the relevant wiki information is available in the documentation with both audiences and their responsibilities clearly covered.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100