diff --git a/.markdownlint-cli2.mjs b/.markdownlint-cli2.mjs index 7ff905477b4..9279b77e008 100644 --- a/.markdownlint-cli2.mjs +++ b/.markdownlint-cli2.mjs @@ -36,7 +36,7 @@ const config = { 'relative-links': true, }, globs: ['**/__docs__/*.md'], - ignores: ['**/node_modules'], + ignores: ['**/node_modules', '__docs__/README-template.md'], customRules: [relativeLinksRule], }; diff --git a/__docs__/README-template.md b/__docs__/README-template.md index 71b6578396c..90c7d3e1e39 100644 --- a/__docs__/README-template.md +++ b/__docs__/README-template.md @@ -1,6 +1,6 @@ # _Subsystem name_ -- [Main doc](../__docs__/README.md) +[🏠 Home](path/to/main/__docs__/README.md) _Description of the subsystem with the necessary context._ diff --git a/packages/react-native-fantom/__docs__/README.md b/packages/react-native-fantom/__docs__/README.md index 03a0dba02bd..9a77e434ad0 100644 --- a/packages/react-native-fantom/__docs__/README.md +++ b/packages/react-native-fantom/__docs__/README.md @@ -1,6 +1,6 @@ # 👻 React Native Fantom -- [Main doc](../../../__docs__/README.md) +[🏠 Home](../../../__docs__/README.md) Fantom is the new **integration testing and benchmarking tool for React Native**. diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/events/__docs__/README.md b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/events/__docs__/README.md index 8658504dfb4..b75f8e5bf2b 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/events/__docs__/README.md +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/fabric/events/__docs__/README.md @@ -1,6 +1,6 @@ # Android event dispatching -- [Main doc](../../../../../../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../../../../../../__docs__/README.md) This directory contains Kotlin classes specific to Android event dispatching in the new architecture. diff --git a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/featureflags/__docs__/README.md b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/featureflags/__docs__/README.md index d390b32cf74..7070e4b81c4 100644 --- a/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/featureflags/__docs__/README.md +++ b/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/internal/featureflags/__docs__/README.md @@ -1,6 +1,6 @@ # Feature Flags -- [Main doc](../../../../../../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../../../../../../__docs__/README.md) This directory contains the Java/Kotlin bindings for the internal React Native feature flags system. diff --git a/packages/react-native/ReactCommon/react/featureflags/__docs__/README.md b/packages/react-native/ReactCommon/react/featureflags/__docs__/README.md index a2b55fb9a81..12ec679621c 100644 --- a/packages/react-native/ReactCommon/react/featureflags/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/featureflags/__docs__/README.md @@ -1,6 +1,6 @@ # Feature Flags -- [Main doc](../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../__docs__/README.md) This directory contains the shared C++ implementation of the internal React Native feature flags system. diff --git a/packages/react-native/ReactCommon/react/nativemodule/featureflags/__docs__/README.md b/packages/react-native/ReactCommon/react/nativemodule/featureflags/__docs__/README.md index a7e9c9d75c9..c6dd01147bf 100644 --- a/packages/react-native/ReactCommon/react/nativemodule/featureflags/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/nativemodule/featureflags/__docs__/README.md @@ -1,6 +1,6 @@ # Feature Flags -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) This directory contains the native C++ TurboModule for the internal React Native feature flags system. diff --git a/packages/react-native/ReactCommon/react/nativemodule/intersectionobserver/__docs__/README.md b/packages/react-native/ReactCommon/react/nativemodule/intersectionobserver/__docs__/README.md index f18f019f99c..a51e2b31429 100644 --- a/packages/react-native/ReactCommon/react/nativemodule/intersectionobserver/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/nativemodule/intersectionobserver/__docs__/README.md @@ -1,6 +1,6 @@ # IntersectionObserver -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) This directory contains the native module used by the [IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver) diff --git a/packages/react-native/ReactCommon/react/nativemodule/microtasks/__docs__/README.md b/packages/react-native/ReactCommon/react/nativemodule/microtasks/__docs__/README.md index 0f7e18eefc9..617815533a0 100644 --- a/packages/react-native/ReactCommon/react/nativemodule/microtasks/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/nativemodule/microtasks/__docs__/README.md @@ -1,6 +1,6 @@ # Microtasks -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) This directory contains the native module used to implement `queueMicrotask` in React Native, which schedules microtasks in the diff --git a/packages/react-native/ReactCommon/react/nativemodule/mutationobserver/__docs__/README.md b/packages/react-native/ReactCommon/react/nativemodule/mutationobserver/__docs__/README.md index 793cae4db48..c96deaefa17 100644 --- a/packages/react-native/ReactCommon/react/nativemodule/mutationobserver/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/nativemodule/mutationobserver/__docs__/README.md @@ -1,6 +1,6 @@ # MutationObserver -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) This directory contains the native module used by the [MutationObserver API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) diff --git a/packages/react-native/ReactCommon/react/renderer/observers/intersection/__docs__/README.md b/packages/react-native/ReactCommon/react/renderer/observers/intersection/__docs__/README.md index de0892a7f51..72e04a6dd2c 100644 --- a/packages/react-native/ReactCommon/react/renderer/observers/intersection/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/renderer/observers/intersection/__docs__/README.md @@ -1,6 +1,6 @@ # IntersectionObserver -- [Main doc](../../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../../__docs__/README.md) This directory contains the C++ implementation of the [IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver) diff --git a/packages/react-native/ReactCommon/react/renderer/observers/mutation/__docs__/README.md b/packages/react-native/ReactCommon/react/renderer/observers/mutation/__docs__/README.md index 2c7f2233822..a0093e0f300 100644 --- a/packages/react-native/ReactCommon/react/renderer/observers/mutation/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/renderer/observers/mutation/__docs__/README.md @@ -1,6 +1,6 @@ # MutationObserver -- [Main doc](../../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../../__docs__/README.md) This directory contains the C++ implementation of the [MutationObserver API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) diff --git a/packages/react-native/ReactCommon/react/renderer/runtimescheduler/__docs__/README.md b/packages/react-native/ReactCommon/react/renderer/runtimescheduler/__docs__/README.md index e648f9a1e95..56ba791dea6 100644 --- a/packages/react-native/ReactCommon/react/renderer/runtimescheduler/__docs__/README.md +++ b/packages/react-native/ReactCommon/react/renderer/runtimescheduler/__docs__/README.md @@ -1,6 +1,6 @@ # Event Loop -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) The Event Loop is the formalization of the execution model for JavaScript in React Native, and how that model synchronizes with rendering work in the host diff --git a/packages/react-native/scripts/featureflags/__docs__/README.md b/packages/react-native/scripts/featureflags/__docs__/README.md index b89f260b2b8..aa9e1932ea5 100644 --- a/packages/react-native/scripts/featureflags/__docs__/README.md +++ b/packages/react-native/scripts/featureflags/__docs__/README.md @@ -1,6 +1,6 @@ # Feature Flags -- [Main doc](../../../../../__docs__/README.md) +[🏠 Home](../../../../../__docs__/README.md) This directory contains the flag definitions and codegen for the internal React Native feature flags system. diff --git a/packages/react-native/src/private/featureflags/__docs__/README.md b/packages/react-native/src/private/featureflags/__docs__/README.md index 48646ade465..04d197b90d0 100644 --- a/packages/react-native/src/private/featureflags/__docs__/README.md +++ b/packages/react-native/src/private/featureflags/__docs__/README.md @@ -1,6 +1,6 @@ # Feature Flags -- [Main doc](../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../__docs__/README.md) Feature flags are values that determine the behavior of specific parts of React Native. This directory contains the configuration for those values, and scripts diff --git a/packages/react-native/src/private/webapis/intersectionobserver/__docs__/README.md b/packages/react-native/src/private/webapis/intersectionobserver/__docs__/README.md index faa477bec21..c8d30472861 100644 --- a/packages/react-native/src/private/webapis/intersectionobserver/__docs__/README.md +++ b/packages/react-native/src/private/webapis/intersectionobserver/__docs__/README.md @@ -1,6 +1,6 @@ # IntersectionObserver -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) This directory contains the React Native implementation of the [IntersectionObserver API](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver). diff --git a/packages/react-native/src/private/webapis/mutationobserver/__docs__/README.md b/packages/react-native/src/private/webapis/mutationobserver/__docs__/README.md index 9b96669b49f..ba8224d9bb2 100644 --- a/packages/react-native/src/private/webapis/mutationobserver/__docs__/README.md +++ b/packages/react-native/src/private/webapis/mutationobserver/__docs__/README.md @@ -1,6 +1,6 @@ # MutationObserver -- [Main doc](../../../../../../../__docs__/README.md) +[🏠 Home](../../../../../../../__docs__/README.md) This directory contains the React Native implementation of the [MutationObserver API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).