NotionX / NotionX/react-notion-x
Documentation error on property name for including next/link component
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.4k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
Description
The example code shown in the readme for how to pass in a next/link component to the renderer has the property name NextLink. From looking at the source it appears this property name actually needs to be PageLink. Using the property NextLink doesn't seem to do anything.
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 at readme.md around line 285 and compare the documented property name with the renderer source referenced in the issue. Done when the example uses the property name that actually accepts the next/link component, and the README no longer shows NextLink.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nextjs, react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100