Example workflows for client commands
Open
Nobody has claimed this yet.
user
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Client documentation would be more useful if it included examples of how commands were meant to be used.
Examples could include:
- Snippet showing reading attributes of a deterministic RSE and adding new DIDs and rules that use it
- Interactions between rules and replicas (making a rule, listing the replicas that rule impacts)
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 locating the client command documentation and the sections covering deterministic RSEs, DIDs, rules, and replicas. Add runnable examples for reading RSE attributes, creating DIDs and rules, and listing replicas affected by a rule; the documentation is done when both requested workflows are clearly demonstrated.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100