Skip to content

docs: add quick start guide using the slack cli and terminal - #1317

Merged
technically-tracy merged 6 commits into
mainfrom
tracy-docs-quickstart
Jul 1, 2025
Merged

docs: add quick start guide using the slack cli and terminal#1317
technically-tracy merged 6 commits into
mainfrom
tracy-docs-quickstart

Conversation

@technically-tracy

@technically-tracytechnically-tracy commented Jun 12, 2025

Copy link
Copy Markdown
Contributor

Summary

Docs: guide quick start app creation using the slack CLI following the Bolt for JS structure authored by @zimeg.

Testing

Category

  • slack_bolt.App and/or its core components
  • slack_bolt.async_app.AsyncApp and/or its core components
  • Adapters in slack_bolt.adapter
  • Document pages under /docs
  • Others

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run ./scripts/install_all_and_run_tests.sh after making the changes.

@codecov

codecovBot commented Jun 12, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.96%. Comparing base (d3ca055) to head (4b6177a).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@ Coverage Diff @@## main #1317 +/- ##
=======================================
Coverage 90.96% 90.96% =======================================
Files 222 222 Lines 7501 7501 =======================================
Hits 6823 6823 Misses 678 678 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zimegzimeg added the docs Improvements or additions to documentation label Jun 13, 2025

@zimegzimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@technically-tracy Wow! Thanks so much for putting this together so fast 🤖 ✨

I left a few comments on changes we'll need to make on the linked sample app and also some sample code we might want to include here!

These paths otherwise read well and some comments have thoughts on separating requirements more, but right now this makes most sense with the current capabilities released in the CLI ⚡

The comments on incoming CLI changes IMO don't have to block this from releasing either if we're alright with fast follows as well! 🚢 💨

Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/building-an-app.md Outdated
Comment threaddocs/content/building-an-app.md Outdated
Comment threaddocs/content/building-an-app.md Outdated

@haleychaashaleychaas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some small nits

zimeg
zimeg previously requested changes Jun 25, 2025

@zimegzimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@technically-tracy The quickstart is quite fast for starting in both setups though perhaps I've created too many apps... 📚

I requested a few changes around commands when setting the app up and exact outputs that might help avoid confusions later.

I'm not sure that automatic virtual environments have landed for the CLI at this time and might need to be documented, but we should revisit this later once that's stable ⛰️ ✨

Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md
Comment threaddocs/content/getting-started.md
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md Outdated
Comment threaddocs/content/getting-started.md Outdated
@zimeg

Copy link
Copy Markdown
Member

👀 I'm noticing tests are failing for some reason also, but perhaps unrelated! Going to investigate this soon 🫡

@zimegzimeg mentioned this pull request Jun 25, 2025
4 tasks
@technically-tracy
technically-tracy dismissed zimeg’s stale reviewJune 26, 2025 12:31

These updates have been made!

@mwbrooksmwbrooks changed the title Docs: guide quick start app creation using the slack cli.docs: add quick start guide using the slack cli and terminalJun 26, 2025

@mwbrooksmwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Amazing work @technically-tracy!

🧪 I've read through the entire Quickstart Guide and manually followed the Slack CLI and Terminal steps. Both paths work well.

👏🏻 I was hoping to give you some feedback, but I have nothing for you. Everything looks excellent from my side!

@zimegzimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@technically-tracy These are great reads! 📚 ✨

Thanks for making all of these updates and changes to the quickstart. Setup feels more quick for me now with both CLI and the browser!

When the time is best for you I think we should ship this 🚢 💨

@technically-tracy
technically-tracy merged commit b9c9999 into mainJul 1, 2025
@technically-tracy
technically-tracy deleted the tracy-docs-quickstart branch July 1, 2025 10:57
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@technically-tracy@zimeg@mwbrooks@haleychaas