Ensure all rose-suite.conf options are documented and document required ones
- Dominant language
- Python
- Stars
- 33
- Forks
- 19
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 30
Description
IIRC there were a couple other things that needed to be set in rose edit, such as the conda build path.
I've been trying to cut down on what need to be set for it to work, but further work is still needed to ensure the example config actually works.
The required options need to be documented up front, and all of the options should have documentation.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating rose-suite.conf and the example configuration, then compare their options with what must be set in rose edit, including the conda build path. Document the required options up front and add documentation for every available option; confirm the example configuration works.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100