Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Overhaul RNW CLI documentation #947

Merged
merged 13 commits into from
Jun 26, 2024
Merged

Overhaul RNW CLI documentation #947

merged 13 commits into from
Jun 26, 2024

Conversation

jonthysell
Copy link
Contributor

@jonthysell jonthysell commented Jun 25, 2024 •
edited
Loading

Description

This PR does multiple things in order to improve the RNW CLI documentation, including:

  • Creating separate pages for each CLI command
  • Updating existing documentation to point to these new pages where appropriate
  • Updated Getting Started to use the new init-windows command
  • Updated other references to the old react-native-windows-init command with links to the new command and changed functionality
  • Clarified references where we used "React Native Windows CLI" as a generic term when we mean specific commands within the CLI

Why

To improve out documentation in time for the 0.75 release.

Resolves microsoft/react-native-windows#13394

Screenshots

N/A

Microsoft Reviewers: Open in CodeFlow

@jonthysell jonthysell marked this pull request as ready for review June 26, 2024 17:48
@jonthysell jonthysell requested a review from a team as a code owner June 26, 2024 17:48
@jonthysell jonthysell added the documentation Improvements or additions to documentation label Jun 26, 2024
@jonthysell jonthysell added this to the 0.75 milestone Jun 26, 2024
TatianaKapos
TatianaKapos approved these changes Jun 26, 2024
View reviewed changes
Copy link
Contributor

@TatianaKapos TatianaKapos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! :) some small nits if you want to take them

docs/codegen-windows-cli.md Outdated Show resolved Hide resolved
docs/init-windows-cli.md Outdated Show resolved Hide resolved
docs/react-native-windows-cli.md Outdated Show resolved Hide resolved
docs/run-windows-cli.md Outdated Show resolved Hide resolved
jonthysell and others added 2 commits June 26, 2024 12:39
@jonthysell @TatianaKapos
Update docs/run-windows-cli.md
194dc6c 
Co-authored-by: Tatiana Kapos <tatianakapos@microsoft.com>
@jonthysell @TatianaKapos
Update docs/react-native-windows-cli.md
0b4b3ed 
Co-authored-by: Tatiana Kapos <tatianakapos@microsoft.com>
jonthysell
jonthysell commented Jun 26, 2024
View reviewed changes
docs/run-windows-cli.md Outdated Show resolved Hide resolved
@jonthysell @TatianaKapos
Apply suggestions from code review
f24f3ef 
Co-authored-by: Tatiana Kapos <tatianakapos@microsoft.com>
@jonthysell jonthysell enabled auto-merge (squash) June 26, 2024 19:43
@jonthysell jonthysell merged commit 8a2f48d into microsoft:main Jun 26, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TatianaKapos TatianaKapos TatianaKapos approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
RNW New Architecture
Status: Done
Milestone
0.75
Development

Successfully merging this pull request may close these issues.

Update documentation with steps for creating a new project using react-native init-windows
2 participants
@jonthysell @TatianaKapos