Inconsistency in the workflow documentation
- Dominant language
- Python
- Stars
- 161
- Forks
- 141
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 138
Description
The documentation pages https://ert.readthedocs.io/en/latest/reference/workflows/complete_workflows.html and https://ert.readthedocs.io/en/latest/reference/configuration/keywords.html#workflow-hooks for workflows are not consistent with each other, for instance one of them is missing the pre/post experiment workflows.
Might be a good idea to consolidate the two?
Contributor guide
Research direction
Compare the two linked workflow documentation pages, starting with the complete workflows page and the workflow-hooks section in the configuration keywords page. Identify the missing pre/post experiment workflows and any other inconsistencies, then consolidate the documentation so both references present the same workflow information.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100