Update API docs
Open
Nobody has claimed this yet.
docs
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 354
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 43
Description
API Docs are quite outdated and sometimes have false information. We should update these docs so users don't have to reverse engineer (and be suprised by api changes with not updated docs)
As examples where this happened:
https://github.com/nextcloud/deck/issues/6830
https://github.com/nextcloud/deck/issues/7681
https://github.com/nextcloud/deck/issues/3127
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
Review the API documentation alongside issues #6830, #7681, and #3127, then compare their claims with the current API behavior. Done means correcting outdated or false information throughout the affected docs so users no longer need to reverse engineer API changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100