React Native docs get new guides, illustrations and a new domain
The React Native team has published an update on its documentation work, shaped by user research carried out last year. The team drew on 24 user interviews and more than 3000 survey responses to learn how and when developers use the docs, and used that data to guide a series of changes now live on the site.
New guides
Several new guides have been added:
- Getting Started: New introductory docs explain what Native Components are for readers without a mobile development background, along with a refresher and introduction to React for those using it for the first time.
- Testing: An illustrated testing guide, created with Vojtech Novak, introduces different testing strategies and how they fit into a React Native workflow.
- Security: An illustrated security guide, created with Kadi Kraman, covers security basics in React Native and recommends solutions.
New illustrations have also been added elsewhere, including in the docs for the new Pressable component and the introduction to React Native components.
A new domain
After five years on a github.io address, the documentation now lives at its own domain, reactnative.dev, which the team notes is easier to type and to autocomplete from a browser's address bar.
Design and reference docs
The site's design and architecture have been reworked to surface and categorize more guides and to make API reference content easier to read. The team credits Bartosz Kaszubowski in particular for much of this work.
A documentation drive involving a group of community contributors brought the Core Component and API reference docs fully up to date, with Snack examples added to all of them in time for React Native 0.62. The team also reports that it has been able to consistently keep open documentation PRs under 10 per week.
What's next
Citing the impact of the COVID-19 pandemic on many community members' jobs, the team plans additional content, including new and improved Native Modules guides and more introductory material for people new to React Native.
How to contribute
The team invites help in several ways: using the "Edit" button on any page to submit a PR for typos or problems, taking part in the documentation survey, and writing content. A tutorial section is in progress, along with planned guides on offline apps, navigation, accessibility, debugging, animations, internationalization, and performance.
Links
Source: reactnative.dev