Add next-gen future documentation #761
Conversation
WilliamBergamin
requested review from
seratch,
filmaj,
misscoded,
hello-ashleyintech and
srajiang
| @@ -1,3 +1,4 @@ | |||
| source 'https://rubygems.org' | |||
| gem 'github-pages', group: :jekyll_plugins | |||
| gem 'dotenv' | |||
| gem 'webrick' | |||
There was a problem hiding this comment.
This seems to be required when new versions of ruby are running Jekyll
| @@ -19,6 +19,7 @@ To learn more about opening configuration modals, [read the documentation](https | |||
|
|
|||
| <div> | |||
| <span class="annotation">Refer to the module documents (<a href="https://slack.dev/bolt-python/api-docs/slack_bolt/kwargs_injection/args.html" target="_blank">common</a> / <a href="https://slack.dev/bolt-python/api-docs/slack_bolt/workflows/step/utilities/index.html" target="_blank">step-specific</a>) to learn the available arguments.</span> | |||
|
|
|||
There was a problem hiding this comment.
My IDE was unable to parse the code block without this line
| padding: 4px 10px; | ||
| border-radius: 12px; | ||
| margin-left: 10px; | ||
| } | ||
| .content .section-wrapper .highlighter-rouge { | ||
| grid-area: code; | ||
| } | ||
|
|
||
| pre { |
There was a problem hiding this comment.
these changes were made to fix a bug in the code block display
Codecov Report
@@ Coverage Diff @@
## main #761 +/- ##
=======================================
Coverage 92.02% 92.02%
=======================================
Files 173 173
Lines 5908 5908
=======================================
Hits 5437 5437
Misses 471 471 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
srajiang
changed the title
| slack run | ||
| ``` | ||
|
|
||
| Executing `pip install -r requirements.txt` installs all the project requirements to your machine. |
There was a problem hiding this comment.
We may want to link to any existing documentation we have around setting up a virtual env, as that is the recommended way of working in Python projects.
There was a problem hiding this comment.
Yeah I've been thinking about doing this in our documentation, currently this is how we do it in the rest of our docs
There was a problem hiding this comment.
Let's chalk it up as a separate issue so we don't forget, and if/when we get to it we can update all the documentation (new platform or otherwise) to link to it where it makes sense.
There was a problem hiding this comment.
I created issue #777 to keep track of this
| slack run | ||
| ``` | ||
|
|
||
| Executing `pip install -r requirements.txt` installs all the project requirements to your machine. |
There was a problem hiding this comment.
Let's chalk it up as a separate issue so we don't forget, and if/when we get to it we can update all the documentation (new platform or otherwise) to link to it where it makes sense.
|
@WilliamBergamin @seratch Do you know when these next gen docs are gonna be available to the end users? |
|
Hi @sharvesh06 thanks for asking these docs are available to users https://slack.dev/bolt-python/future/concepts You must use the beta release of python to try this out, it end with |
This PR aims to add documentation for
I am seeking feedback on
NOTE everything in docs/api-docs/slack_bolt/ is generated code no need to review it
In order to run the documentation locally:
Category (place an
xin each of the[ ])slack_bolt.Appand/or its core componentsslack_bolt.async_app.AsyncAppand/or its core componentsslack_bolt.adapter/docsRequirements (place an
xin each[ ])Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
./scripts/install_all_and_run_tests.shafter making the changes.