stackbuilders / stackbuilders/react-native-spotlight-tour
Broken links in API reference docs
Open
documentation
- Dominant language
- TypeScript
- Stars
- 520
- Forks
- 39
- PR merge metrics
- No merged PRs in 30d
Description
"Defined in" links are broken in the API Reference docs.
Example: AttachStepProps docs
https://www.loom.com/share/fc9c74d1d4d94e2b894c32fc7a79deb1?sid=1f4b6ba0-e7d7-47a8-8d99-9fff4695058b
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 API Reference documentation and the example AttachStepProps page to reproduce the broken “Defined in” link. Inspect how these links are generated or published, then verify that the API reference links resolve correctly after the change; pull request #200 is already open for this issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100