Files
react-native/__docs__/README-template.md
T
Rubén Norte 907185333a Define technical documentation guidance and template (#50332)
Summary:
Pull Request resolved: https://github.com/facebook/react-native/pull/50332

Changelog: [internal]

This defines a detailed strategy on how to approach internal technical documentation in React Native, including defining a template for subsystem documentation.

Reviewed By: javache, rshest

Differential Revision: D71889754

fbshipit-source-id: 5ce630b2e71f8c7b6aaf027a5833bcbdf0dfa5de
2025-03-28 05:28:44 -07:00

939 B

Subsystem name

Description of the subsystem with the necessary context.

Usage

Explanation of how the subsystem is used.

Design

Explain how the subsystem is designed, relevant implementation details, etc. Ideally include an Excalidraw diagram.

Relationship with other systems

Part of

  • A single bullet for the parent subsystem. Link to the documentation of that subsystem if it exists.

Part of this

  • One bullet point for each subsystem that is part of this one. Link to the documentation of those subsystems if it exists.

Used by this

  • One bullet point for each subsystem used by this one, explaining why it uses it and how. Link to the documentation of those subsystems if it exists.

Uses this

  • One bullet point for each subsystem using this one, explaining why it uses it and how. Link to the documentation of those subsystems if it exists.