Skip to content
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

Documentation is missing info for routing #246

Closed
4 of 9 tasks
SpencerKaiser opened this issue Sep 10, 2019 · 2 comments
Closed
4 of 9 tasks

Documentation is missing info for routing #246

SpencerKaiser opened this issue Sep 10, 2019 · 2 comments
Labels
docs M-T: Documentation work only

Comments

@SpencerKaiser
Copy link

Description

Documentation isn't clear about Bolt's routing and what the base URL should be. The info below is addressed in the Getting Started guide, but only in a single, buried sentence.

What type of issue is this? (place an x in one of the [ ])

  • bug
  • enhancement (feature request)
  • question
  • documentation related
  • testing related
  • discussion

Requirements (place an x in each of the [ ])


Documentation Issue

As a first time Bolt developer, I wasn't sure what the base URL would be. I assumed (naively) that my Slash command /something should be directed to https://myapp.com/something, yet that is not the case. As mentioned in Getting Started, the app listens to /slack/events by default, yet that isn't mentioned anywhere in the README.

Suggested Solution

Update the README with a section for Routing that explains the base URL for the app is /slack/events but can be overridden using the endpoints parameter of the app constructor.

@SpencerKaiser
Copy link
Author

If this is an addition y'all would like, I'll open a PR with the changes!

@shaydewael shaydewael added the docs M-T: Documentation work only label Oct 1, 2019
@shaydewael
Copy link
Contributor

Updated this in the Getting Started guide and the README (#609), so I think we're safe to close this issue. Feel free to reopen if the changes are insufficient!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

No branches or pull requests

2 participants