microsoft / microsoft/BotFramework-WebChat
Generate HOOKS.md from JSDoc of `/(api|component)/src/hooks/*`
Open
Nobody has claimed this yet.
area-docs
feature-request
- Dominant language
- HTML
- Stars
- 1.8k
- Forks
- 1.6k
- Avg merge
- 22h 58m
- Merged PRs (30d)
- 2
Description
As we typed all our public interfaces in PR #3931. We should consider moving content of HOOKS.md into the TypeScript files, then extract contents back into HOOKS.md.
[feature-request]
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 by reading HOOKS.md and the TypeScript files under /(api|component)/src/hooks/*, then review PR #3931 for the interface context. Define how the existing HOOKS.md content maps to JSDoc and what generation step should own it; the work is done when the documented hook content can be maintained in the TypeScript files and extracted into HOOKS.md.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100