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.

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

fix(core): update generated README pages with more useful instructions #21976

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

jaysoo
Copy link
Member

@jaysoo jaysoo commented Feb 23, 2024

This PR updates the README.md that is generated with create-nx-workspace.

The goal is to provide users with updated and relevant information for the type of workspace they generate. There are three groups of workspaces that is handled:

  1. TS standalone (a single TS lib inside root src/ folder)
  2. TS monorepo (either package-based or integrated)
  3. Workspace with an app (React, Vue, Angular, Next.js, Nuxt, etc.)

Changes:

  • Fix instructions for Next.js to be nx dev not nx serve (since we changed it to keep consistent with Next.js CLI)
  • Fix TS standalone so README is correct (previously it was missing 90% of the info)
  • Move Nx Console instructions to the top so it is more prominent (it is very important now with Project Crystal)
  • Add section about nx add and nx g for TS monorepo (since we made it possible to use plugins with package-base monorepos as well)

@jaysoo jaysoo requested review from a team as code owners February 23, 2024 19:40
@jaysoo jaysoo requested a review from AgentEnder February 23, 2024 19:40
Copy link

vercel bot commented Feb 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Updated (UTC)
nx-dev ⬜️ Ignored (Inspect) Visit Preview Feb 23, 2024 7:59pm

@jaysoo jaysoo force-pushed the feat_initial_setup branch from 202e701 to 81605f5 Compare February 23, 2024 19:50
@jaysoo jaysoo changed the title feat(core): update generated README pages with more useful instructions fix(core): update generated README pages with more useful instructions Feb 23, 2024
@jaysoo jaysoo force-pushed the feat_initial_setup branch from 81605f5 to e04eda8 Compare February 23, 2024 19:58
@jaysoo jaysoo merged commit 26b266f into master Feb 23, 2024
6 checks passed
@jaysoo jaysoo deleted the feat_initial_setup branch February 23, 2024 21:09
Copy link

github-actions bot commented Mar 4, 2024

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants