search

slackapi / bolt-js

A framework to build Slack apps using JavaScript
https://tools.slack.dev/bolt-js/
MIT License
2.75k stars 395 forks source link

Reference documentation for bolt-js #833

Open seratch opened 3 years ago

seratch commented 3 years ago

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

seratch commented 3 years ago

https://github.com/slackapi/bolt-js/issues/277 is not related to the auto-generated document like typedocs but the topic should be related to this issue.

filmaj commented 2 months ago

Renaming this issue to be more about reference documentation - with the work @lukegalbraithrussell has done, we now have pretty good baseline reference docs for the node-slack-sdk (see e.g. here), and we should do something similar for bolt-js.

lukegalbraithrussell commented 2 months ago

Yes, the node docs use TypeDocs! We can definitely do the same here. I'll implement this after Dreamforce/PTO

filmaj commented 1 month ago

I've created a branch where I'm playing around with this, over in generated-ref-docs. You can pull that branch down, cd docs and run npm i && npm start. I haven't wired up the generated ref docs into the sidebar, so you'll have to manually load /bolt-js/ref for now to see it.

Need to figure out how to consolidate the hand-written reference docs we have today with the generated ones; I'm thinking fold the hand-written docs into comment blocks into the code so that the generated ref docs incorporate them?

filmaj commented 1 month ago

I really like the deno reference docs: https://docs.deno.com/api/deno/file-system

Need to study how those are generated via this repo: https://github.com/denoland/docs?tab=readme-ov-file

Wonder if their approach would work for us