-
Notifications
You must be signed in to change notification settings - Fork 399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a document section about deferInitialization option when releasing v3.10 #1304
Comments
Thinking about where to add this documentation, I am not entirely sure. My initial thought is a new section under the 'Advanced Concepts' of the bolt-js docs - perhaps "Deferring initialization"? This would be a short section, similar perhaps to the Logging doc, describing 1) why someone would want to defer initialization, 2) how to do it and 3) what errors to expect if this is done incorrectly. Some ideas for copy for these sections:
Thoughts/opinions/comments? Oh, and of course updating any reference-style documentation would be in order, too. |
@filmaj All look good to me!
Yes, specifically, https://slack.dev/bolt-js/reference#app-options should be updated too. |
@filmaj How about instead of:
Something along the lines of: Bolt offers a way to defer full initialization via the |
Thanks for the comments and suggestions! PR is up here, if you have further comments or reviews let's move it to the PR: #1308 |
The pull request #1303 in v3.10 milestone will add a new option
deferInitialization
. We can add a corresponding document section for it when it's released.This is great, thanks for tackling this @seratch !
Not sure if we should bundle the documentation for this feature in this PR, or a separate one, but I think before merging this PR we should at least write a draft of the docs for this support. In my experience, writing up the docs alongside (or even before) the code is written up can help clarify how to structure the code too. I am happy to help write the docs if you would find that helpful - let me know, I can try to create a draft!
Originally posted by @filmaj in #1303 (review)
The text was updated successfully, but these errors were encountered: