How to document `optional` field from housing Block and how it applies to Block Elements within?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.9k
- Forks
- 445
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 28
Description
Currently multi_external_select (link), requires you to select at least one option, otherwise, it fails the validation.
We worked around that by providing a default option none and people can remove it and add the options related to the content they are filling in.
However, it would be a better UX if the field is optional.
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 linked Slack Block Kit reference for the multi_external_select fields and inspect the repository's existing documentation structure for the appropriate entry point. Clarify how the optional field setting on a Block applies to its Block Elements, including the validation behavior described in the issue. Done means the documented behavior is accurate and easy to find.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100