Skip to content

Commit db4b3df

Browse files
rubennortefacebook-github-bot
authored andcommitted
Use emojis in technical docs titles (#50699)
Summary: Pull Request resolved: #50699 Changelog: [internal] Just changing the template to include emojis in the top level titles to make it easier to scan the doc Reviewed By: lenaic Differential Revision: D72961870 fbshipit-source-id: 64c45e7ac769c38af06ea318cdb581a04e230f90
1 parent ab47834 commit db4b3df

File tree

17 files changed

+32
-32
lines changed

17 files changed

+32
-32
lines changed

__docs__/README-template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44

55
_Description of the subsystem with the necessary context._
66

7-
## Usage
7+
## 🚀 Usage
88

99
_Explanation of how the subsystem is used._
1010

11-
## Design
11+
## 📐 Design
1212

1313
_Explain how the subsystem is designed, relevant implementation details, etc.
1414
Ideally include an Excalidraw diagram._
1515

16-
## Relationship with other systems
16+
## 🔗 Relationship with other systems
1717

1818
### Part of
1919

__docs__/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Native and contribute to it. **End users of React Native are meant to use the
1212
For details on how we approach technical documentation in this repository, see
1313
[GUIDELINES.md](./GUIDELINES.md).
1414

15-
## Usage
15+
## 🚀 Usage
1616

1717
This repository is not meant to be consumed directly by end users. Instead, it
1818
creates several packages that are published to the NPM registry for direct
@@ -30,11 +30,11 @@ JavaScript API.
3030
This repository provides the Android and iOS versions of React Native. Versions
3131
for other platforms are maintained in their own repositories.
3232

33-
## Design
33+
## 📐 Design
3434

3535
TODO: Explain the different components of React Native at a high level.
3636

37-
## Relationship with other systems
37+
## 🔗 Relationship with other systems
3838

3939
### Part of this
4040

packages/react-native-fantom/__docs__/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ interact with React Native and observe what effects it has on a mock host
4747
platform. It exposes fine grained controls over scheduling, making it possible
4848
to test cases that are hard to reproduce manually.
4949

50-
## Usage
50+
## 🚀 Usage
5151

5252
> [!WARNING]
5353
>
@@ -194,7 +194,7 @@ has simple examples you can learn from.
194194

195195
If you have any questions not answered here, please reach out to us.
196196

197-
## Design
197+
## 📐 Design
198198

199199
![Diagram of the architecture of Fantom in React Native](./architecture.excalidraw.svg)
200200

@@ -223,7 +223,7 @@ The runner then follows these steps:
223223
3. The runner receives the output from the Fantom CLI and reports the provided
224224
results back to Jest in the correct format.
225225

226-
## Relationship with other systems
226+
## 🔗 Relationship with other systems
227227

228228
### Part of this
229229

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/events/__docs__/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
This directory contains Kotlin classes specific to Android event dispatching in
66
the new architecture.
77

8-
## Design
8+
## 📐 Design
99

1010
![Diagram showing how an event is processed in the new architecture](./life-of-an-event.excalidraw.svg)
1111

12-
## Relationship with other systems
12+
## 🔗 Relationship with other systems
1313

1414
### Part of
1515

packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/featureflags/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This directory contains the Java/Kotlin bindings for the internal React Native
66
feature flags system.
77

8-
## Relationship with other systems
8+
## 🔗 Relationship with other systems
99

1010
### Part of
1111

packages/react-native/ReactCommon/react/featureflags/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This directory contains the shared C++ implementation of the internal React
66
Native feature flags system.
77

8-
## Relationship with other systems
8+
## 🔗 Relationship with other systems
99

1010
### Part of
1111

packages/react-native/ReactCommon/react/nativemodule/featureflags/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This directory contains the native C++ TurboModule for the internal React Native
66
feature flags system.
77

8-
## Relationship with other systems
8+
## 🔗 Relationship with other systems
99

1010
### Part of
1111

packages/react-native/ReactCommon/react/nativemodule/intersectionobserver/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains the native module used by the
66
[IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver)
77
in React Native.
88

9-
## Relationship with other systems
9+
## 🔗 Relationship with other systems
1010

1111
### Part of
1212

packages/react-native/ReactCommon/react/nativemodule/microtasks/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains the native module used to implement `queueMicrotask` in
66
React Native, which schedules microtasks in the
77
[Event Loop](../../../renderer/runtimescheduler/__docs__/README.md).
88

9-
## Relationship with other systems
9+
## 🔗 Relationship with other systems
1010

1111
### Part of
1212

packages/react-native/ReactCommon/react/nativemodule/mutationobserver/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains the native module used by the
66
[MutationObserver API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)
77
in React Native.
88

9-
## Relationship with other systems
9+
## 🔗 Relationship with other systems
1010

1111
### Part of
1212

packages/react-native/ReactCommon/react/renderer/observers/intersection/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains the C++ implementation of the
66
[IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver)
77
in React Native.
88

9-
## Relationship with other systems
9+
## 🔗 Relationship with other systems
1010

1111
### Part of
1212

packages/react-native/ReactCommon/react/renderer/observers/mutation/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This directory contains the C++ implementation of the
66
[MutationObserver API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)
77
in React Native.
88

9-
## Relationship with other systems
9+
## 🔗 Relationship with other systems
1010

1111
### Part of
1212

packages/react-native/ReactCommon/react/renderer/runtimescheduler/__docs__/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ semantics and APIs.
2727
> which contains additional context (e.g.: how this was introduced and what
2828
> React Native had before).
2929
30-
## Usage
30+
## 🚀 Usage
3131

3232
The event loop is an implementation detail so it is not used directly, but
3333
several APIs integrate deeply with it:
@@ -99,7 +99,7 @@ function Content(props) {
9999
}
100100
```
101101

102-
## Design
102+
## 📐 Design
103103

104104
The conceptual model is **aligned with
105105
[the model on the Web](https://html.spec.whatwg.org/multipage/webappapis.html#event-loop-processing-model)**
@@ -185,7 +185,7 @@ used in the new architecture).
185185
That class implements both the task scheduler that handles priorities and the
186186
processing of those tasks within the event loop.
187187

188-
## Relationship with other systems
188+
## 🔗 Relationship with other systems
189189

190190
### Part of this
191191

packages/react-native/scripts/featureflags/__docs__/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This directory contains the flag definitions and codegen for the internal React
66
Native feature flags system.
77

8-
## Relationship with other systems
8+
## 🔗 Relationship with other systems
99

1010
### Part of
1111

packages/react-native/src/private/featureflags/__docs__/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ There are 2 types of feature flags:
1212
everywhere.
1313
- JS-only: they can only be accessed and customized from JavaScript.
1414

15-
## Usage
15+
## 🚀 Usage
1616

1717
### Defining feature flags
1818

@@ -188,7 +188,7 @@ If you need to consume this as structured data, you can print it as JSON using:
188188
yarn featureflags --print --json
189189
```
190190

191-
## Design
191+
## 📐 Design
192192

193193
The architecture of this feature flags system can be described as follows:
194194

@@ -210,7 +210,7 @@ The codegen uses a simple templating system based on JavaScript template strings
210210
to generate the files (see files ending with `-template.js` in the
211211
[`templates`](../../../../scripts/featureflags/templates/) directory),
212212

213-
## Relationship with other systems
213+
## 🔗 Relationship with other systems
214214

215215
### Part of this
216216

packages/react-native/src/private/webapis/intersectionobserver/__docs__/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
This directory contains the React Native implementation of the
66
[IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver).
77

8-
## Usage
8+
## 🚀 Usage
99

1010
`IntersectionObserver` is meant to be used from JavaScript, exposed as a global
1111
class.
1212

13-
## Design
13+
## 📐 Design
1414

1515
This is the high-level design of the IntersectionObserver API:
1616

@@ -32,7 +32,7 @@ for the given surface. If there are, we just wait for the transaction to be
3232
mounted and use the mount hook to report the initial notification. If there
3333
aren't, we dispatch the notification immediately.
3434

35-
## Relationship with other systems
35+
## 🔗 Relationship with other systems
3636

3737
### Part of this
3838

packages/react-native/src/private/webapis/mutationobserver/__docs__/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
This directory contains the React Native implementation of the
66
[MutationObserver API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).
77

8-
## Usage
8+
## 🚀 Usage
99

1010
`MutationObserver` is meant to be used from JavaScript, exposed as a global
1111
class.
1212

13-
## Design
13+
## 📐 Design
1414

1515
This is the high-level design of the MutationObserver API:
1616

@@ -24,7 +24,7 @@ changes in the tree, and detects mutations using the before/after revisions. It
2424
relies on referential equality of the shadow nodes for performance
2525
optimizations.
2626

27-
## Relationship with other systems
27+
## 🔗 Relationship with other systems
2828

2929
### Part of this
3030

0 commit comments

Comments
 (0)