Reference documentation for bolt-js
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.9k
- Forks
- 445
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 28
Description
Related to this, Can we get TypeDocs for this project so it's easier to use?
https://typedoc.org/
I have struggled a lot in the last couple of days figuring the types and way this works and it's been hard with the current state of docs!
Originally posted by @msrivastav13 in https://github.com/slackapi/bolt-js/issues/826#issuecomment-798833756
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 with the TypeDoc documentation linked in the issue and inspect the bolt-js TypeScript project configuration to determine how reference documentation could be generated. Done means the project's TypeScript API has usable TypeDoc reference documentation, though the issue does not specify an output location or publishing process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100