From ddb3ba6251498efb3085316cf4eb0d58dd524400 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rub=C3=A9n=20Norte?= Date: Tue, 8 Apr 2025 01:56:56 -0700 Subject: [PATCH] Rename DOCS.md as GUIDELINES.md (#50525) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/50525 Changelog: [internal] Just a rename of the file and moving relevant documentation to the README. Differential Revision: D72562795 --- __docs__/{DOCS.md => GUIDELINES.md} | 6 ++---- __docs__/README.md | 8 +++++--- 2 files changed, 7 insertions(+), 7 deletions(-) rename __docs__/{DOCS.md => GUIDELINES.md} (87%) diff --git a/__docs__/DOCS.md b/__docs__/GUIDELINES.md similarity index 87% rename from __docs__/DOCS.md rename to __docs__/GUIDELINES.md index ced5de0de654..7c4aa5e9159b 100644 --- a/__docs__/DOCS.md +++ b/__docs__/GUIDELINES.md @@ -1,8 +1,6 @@ -# React Native Technical Documentation +# React Native Technical Documentation Guidelines -The React Native technical documentation describes how React Native works internally, the subsystems it is composed of, how they work and how they interact with each other. - -The intended audience is people who want to learn about the internals of React Native and contribute to it. **End users of React Native are meant to use the [public website](https://reactnative.dev) instead** (its code can be found [here](https://github.com/facebook/react-native-website)). +_This is a document about documentation (hence the file name)._ ## Motivation diff --git a/__docs__/README.md b/__docs__/README.md index de158a2b5c29..40ab0ddb9dad 100644 --- a/__docs__/README.md +++ b/__docs__/README.md @@ -1,8 +1,10 @@ -# React Native Documentation +# React Native Technical Documentation -This is the internal technical documentation for React Native. It is not intended for end users of the platform. +The React Native technical documentation describes how React Native works internally, the subsystems it is composed of, how they work and how they interact with each other. -For information on our documentation strategy and structure, see [DOCS.md](./DOCS.md). +The intended audience is people who want to learn about the internals of React Native and contribute to it. **End users of React Native are meant to use the [public website](https://reactnative.dev) instead** (its code can be found [here](https://github.com/facebook/react-native-website)). + +For details on how we approach technical documentation in this repository, see [GUIDELINES.md](./GUIDELINES.md). ## Usage