docs: document workflow token behaviors
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.9k
- Forks
- 445
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 28
Description
Assumptions that bolt makes around workflow token and how they are used is not documented, this can lead to some confusion. I think we should document that whenever a workflow token is found in an event payload it will be used by the client injected into the handler. It is also worth documenting that this behavior can be disabled with attachFunctionToken = false
List any relevant URLs
https://tools.slack.dev/bolt-js/concepts/custom-steps
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the custom steps documentation at the linked concepts/custom-steps page. Document how a workflow token in an event payload is used by the injected client and how attachFunctionToken = false disables that behavior; done means both behaviors are clearly explained there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100