microsoft / microsoft/react-native-windows-samples
Add context page for API docs
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- C#
- Stars
- 544
- Forks
- 218
- PR merge metrics
- No merged PRs in 30d
Description
It would be good to add a page that sets context on what the API docs section is doing - point to RN docs for all RN APIs, set context on Windows specific work, Mac specific work etc., Right now it is confusing to land in that section without context.
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 locating the API docs section and reviewing how its existing pages are organized. Add a context page that points readers to the React Native API docs and explains the Windows- and macOS-specific work; done when a new reader can understand the section's purpose and scope.
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
- 38/100