Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/50335 Changelog: [internal] This defines the internal technical documentation for the MutationObserver API, as an example of how to define docs using the new strategy and structure. Reviewed By: javache Differential Revision: D71890748 fbshipit-source-id: 3ef19c784dff7aea7a2e2d08302640d5eefacc30
React Native Documentation
This is the internal technical documentation for React Native. It is not intended for end users of the platform.
For information on our documentation strategy and structure, see DOCS.md.
Usage
This repository is not meant to be consumed directly by end users. Instead, it creates several packages that are published to the NPM registry for direct consumption by end users and frameworks.
This repository uses a monorepo approach, and public packages can be found in the packages directory (the ones that do not contain "private": true in their package.json file).
The most important package is the react-native package, located in packages/react-native, which contains the public JavaScript API.
This repository provides the Android and iOS versions of React Native. Versions for other platforms are maintained in their own repositories.
Design
TODO: Explain the different components of React Native at a high level.
Relationship with other systems
Part of this
- Feature Flags
- Web APIs
Used by this
This repository has many different types of dependencies: build systems, external packages to be used during development, external packages used at runtime, etc.
Uses this
The main use cases for this repository are:
- Developing React Native itself.
- Testing and releasing React Native.
- Synchronizing forks like
react-native-windowsandreact-native-macos.