Update reusable workflow documentation and diagram
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.5k
- Forks
- 391
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 19
Description
Checklist (Please check before submitting)
- I reviewed the Contributing Guide.
- I reviewed the cFS README.md file to see if the feature is in the major future work.
- I performed a cursory search to see if the feature request is relevant, not redundant, nor in conflict with other tickets.
Is your feature request related to a problem? Please describe.
As we add new workflows we should keep documentation up to date
Describe the solution you'd like
New diagrams and updated workflow summaries
Describe alternatives you've considered
Remove documentation and maintain with each file
Additional context
None
Requester Info
Gerardo E. Cruz-Ortiz
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 CONTRIBUTING.md and README.md, then inventory the reusable workflows that need coverage. Compare the existing workflow summaries and diagrams with the current workflows; done means the documentation and diagrams are updated for the workflows in scope, though the issue does not identify those files or the exact scope.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100