Skip to content

Commit e7f501b

Browse files
authored
Add note about Old and New Architectures to relevant docs (#1029)
## Description This PR adds a notice to the top of every relevant page that is either clearly: 1. *Old Architecture Only*: doc is for Old Architecture features not planned/supported in the New Arch 2. *Architecture Review Needed*: doc may or may not apply to in the new architecture and therefore needs further review. I've also added the appropriate tag on every page: ![Architecture](https://img.shields.io/badge/architecture-new_&_old-green) ![Architecture](https://img.shields.io/badge/architecture-new_only-blue) ![Architecture](https://img.shields.io/badge/architecture-old_only-yellow) ![Architecture](https://img.shields.io/badge/architecture-needs_review-red) ### Why Lots of things change with the migration to the New Architecture, and we want to give some warning about docs that may be out of date while we sort out which to update, which to deprecate, etc. Resolves #1014 ## Screenshots N/A ###### Microsoft Reviewers: [Open in CodeFlow](https://microsoft.github.io/open-pr/?codeflow=https://github.com/microsoft/react-native-windows-samples/pull/1029)
1 parent dfb88a6 commit e7f501b

48 files changed

Lines changed: 159 additions & 2 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/app-publishing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: app-publishing
33
title: Publishing a React Native Windows App to the Microsoft Store
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-needs_review-red)
7+
8+
> **Architecture Review Needed:** This documentation was written to support development against React Native's "Old" or "Legacy" Architecture. It *may or may not* be directly applicable to New Architecture development and needs to be reviewed and potentially updated. For information on React Native architectures in React Native Windows, see [New vs. Old Architecture](new-architecture.md).
9+
610
## Steps to Publish a React Native Windows App to the Microsoft Store
711
These are the steps to follow if you are looking to publish a React Native Windows app as a third party to the Microsoft Store. Since React Native Windows apps are Universal Windows Platform (UWP) apps, you can also see [Publish Windows apps - UWP applications | Microsoft Docs](https://docs.microsoft.com/windows/uwp/publish/) for all kinds of documentation on the UWP app publishing process.
812

docs/autolink-windows-cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: autolink-windows-cli
33
title: react-native autolink-windows
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-new_&_old-green)
7+
68
This guide will give you more information on the `autolink-windows` command of the React Native Windows CLI.
79

810
## `autolink-windows`

docs/codegen-windows-cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: codegen-windows-cli
33
title: react-native codegen-windows
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-new_&_old-green)
7+
68
This guide will give you more information on the `codegen-windows` command of the React Native Windows CLI.
79

810
## `codegen-windows`

docs/config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: config
33
title: React Native Config Schema
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-needs_review-red)
7+
8+
> **Architecture Review Needed:** This documentation was written to support development against React Native's "Old" or "Legacy" Architecture. It *may or may not* be directly applicable to New Architecture development and needs to be reviewed and potentially updated. For information on React Native architectures in React Native Windows, see [New vs. Old Architecture](new-architecture.md).
9+
610
The CLI command [`npx react-native config`](https://github.com/react-native-community/cli/blob/master/docs/commands.md#config) outputs project and dependencies configuration in JSON format to `stdout`.
711

812
The following describes the schema for projects and dependencies provided by React Native for Windows.

docs/customizing-SDK-versions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: customizing-sdk-versions
33
title: Customizing SDK versions
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-needs_review-red)
7+
8+
> **Architecture Review Needed:** This documentation was written to support development against React Native's "Old" or "Legacy" Architecture. It *may or may not* be directly applicable to New Architecture development and needs to be reviewed and potentially updated. For information on React Native architectures in React Native Windows, see [New vs. Old Architecture](new-architecture.md).
9+
610
It is easy for an app to customize which versions of the Windows SDK and WinUI 2.x to use.
711

812
### Details

docs/debugging-javascript.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: debugging-javascript
33
title: JavaScript Debugging
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-needs_review-red)
7+
8+
> **Architecture Review Needed:** This documentation was written to support development against React Native's "Old" or "Legacy" Architecture. It *may or may not* be directly applicable to New Architecture development and needs to be reviewed and potentially updated. For information on React Native architectures in React Native Windows, see [New vs. Old Architecture](new-architecture.md).
9+
610
This page details how to debug the JavaScript code in your RNW applications, including which tools are supported in which scenarios. You have two different options: *Direct Debugging* and *Web Debugging*.
711

812
> Unless stated otherwise, each of the debugging scenarios detailed below assume you're loading your JS bundle from the Metro Packager, not loading a prebuilt bundle file.

docs/flyout-component-windows.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: flyout-component
33
title: Flyout
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-old_only-yellow)
7+
8+
> **Old Architecture Only:** This documentation describes a feature only supported by React Native's "Old" or "Legacy" Architecture. We are still in the progress of updating all of the documentation, but in the meantime, for information on React Native architectures in React Native Windows, see [New vs. Old Architecture](new-architecture.md).
9+
610
# Reference
711

812
## Props

docs/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: getting-started
33
title: Get Started with Windows
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-new_&_old-green)
7+
68
This guide will help you get started on setting up your very first React Native for Windows app.
79

810
Make sure you have installed all of the [development dependencies](rnw-dependencies.md).

docs/glyph-component-windows.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: glyph-component
33
title: Glyph
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-old_only-yellow)
7+
8+
> **Old Architecture Only:** This documentation describes a feature only supported by React Native's "Old" or "Legacy" Architecture. We are still in the progress of updating all of the documentation, but in the meantime, for information on React Native architectures in React Native Windows, see [New vs. Old Architecture](new-architecture.md).
9+
610
# Reference
711

812
## Props

docs/hermes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ id: hermes
33
title: Hermes on Windows + macOS
44
---
55

6+
![Architecture](https://img.shields.io/badge/architecture-new_&_old-green)
7+
68
# Hermes
79

810
The [Hermes](https://hermesengine.dev/) engine is an open source JavaScript engine created by Facebook to optimize building and running React Native applications.

0 commit comments

Comments
 (0)