Documentation lacking illustrations
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7.2k
- Forks
- 748
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 1
Description
Description
Hi! I've been using your library for a while now, and it has been really helpful for my team, allowing us to build really good mobile apps. However, some team members have noticed that, in some parts of the documentation, they didn't know what the components looked like because some of the Figma links were broken or non-existent.
Related to
- Docs
Steps to reproduce
Steps to reproduce the behavior:
- Go to 'https://wix.github.io/react-native-ui-lib/docs/components/charts/PieChart'
- Scroll down until you see the illustration
- You are going to see a figma warning telling you that the link is broken
Expected behavior
I think that displaying a picture could be enough since it can be hosted directly on the website.
Actual behavior
Broken link
More Info
Screenshots/Video
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
Open the PieChart documentation page at https://wix.github.io/react-native-ui-lib/docs/components/charts/PieChart and inspect the illustration section and its broken Figma link. Replace the broken link with a directly hosted picture, then verify that the illustration displays correctly on the documentation page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100