Top level documentation block is never picked up
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 114
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/reasonml-community/bs-react-native/pull/198/commits/1051db5faf8b0950649c4222993b73d37bd1fc5a
An instance of the problem is here ^
Contributor guide
No contributing guide indexed for this repository
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 examining the linked bs-react-native pull-request commit and how redoc consumes its documentation blocks. Trace the handling of a top-level documentation block, then verify that the instance referenced in the issue is picked up without regressing existing documentation generation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100