handsontable / handsontable/hyperformula
API reference should contain only the public API
Open
Nobody has claimed this yet.
Docs
Impact: Medium
- Dominant language
- TypeScript
- Stars
- 2.8k
- Forks
- 171
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 7
Description
Description
- analyze our code and define what exactly is public and should be included in the API reference
- make sure all the code in our public API is well documented
- configure the tools that generate our documentation to include only the public API (check how it's configured in HOT, it might be helpful)
Links
- #1483
- https://handsoncode.slack.com/archives/C044LF2LF71/p1666078448176849 (internal discussion accessible by budnix krzysztofspilka and sequba)
- https://handsoncode.slack.com/archives/C031GBX62SE/p1666338806014269 (internal discussion)
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 issue #1483 and the linked API-reference discussion, then audit the generated documentation and its configuration. Done means the public API is explicitly defined, all public API code is documented, and the documentation tools exclude non-public code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100