We should probably only document Operations
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 20
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 6
Description
I've just been doing some documentation work and I've got a whole bit about how "not all adaptor functions are operations".
And while that's technically true, there's only a small number of exceptions and I don't think any of them are designed for job writers.
Life would be a lot easier if we only publicly documented the actual Operations and hid everything else away.
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 by reviewing the existing documentation section about adaptor functions and the distinction between Operations and exceptions. Done means the public documentation clearly focuses on Operations intended for job writers, with non-Operations either removed or explicitly kept private; the issue does not name specific files or tests.
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