StackExchange / StackExchange/Stacks-Editor
Add documentation for exposed types
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 437
- Forks
- 61
- Avg merge
- 16h 2m
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
There is absolutely no user-facing documentation for any of the exposed types/interfaces.
Describe the solution you'd like
Autogeneration of documentation from the exported types would be nice.
Describe alternatives you've considered
A simple web search turns up a few options, such as this or this. Additionally, api-extractor, which I've looked into using for other reasons, can do this as well.
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 reviewing the TypeScript exported types and interfaces, then compare the documentation-generation options mentioned in the issue: TypeDoc, typegen, and api-extractor. Done means the exposed types have user-facing documentation generated and the chosen approach is integrated into the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100