Better documentation for `--cache-step`
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 20
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 6
Description
I thought we had more examples of this but the only docs I can see are in the CLI docs: https://docs.openfn.org/documentation/cli-usage#handle-output-state
This is such a cool and important feature! I want to share it with a user today but I don't have the docs to back it :(
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 with the linked CLI documentation at the “Handle output state” section and review how --cache-step is currently explained. Add the missing examples and context needed to demonstrate the feature, then verify that the CLI documentation clearly explains how users can apply it.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100