Automattic / Automattic/kue

Add documentation for methods/events

Open
#1,088 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
9.4k
Forks
858
PR merge metrics
No merged PRs in 30d

Description

It would be really cool to have the documentation on each method/event that we can use. We can look into README.md for that, but I think it'll be way more better if we had the separate page that describes each API method/event that we can subscribe to, what arguments it accepts, what does it return, how it works, which errors can it throw etc.

This could be implemented by using the Github Wiki, or adding a Markdown file to a repository (IMHO the second way would be more cool).

I can make a PR on that, just wondering if it would be useful.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with README.md and inventory the methods and events exposed by the API. Done means adding a separate Markdown reference that documents each method/event, its arguments, return value, behavior, and possible errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.