Improve docs for blitz start, blitz dev, blitz build
#804
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://github.com/blitz-js/blitz/blob/main/packages/blitz/src/cli/commands/next/build.ts does not allow any options. The env is hard coded to `"prod"`. Link to `next build` docs.
Add options based on https://github.com/blitz-js/blitz/blob/main/packages/blitz/src/cli/commands/next/build.ts#L8; same line as for `blitz start` and `blitz dev`.
Clarify that this will use the development environment. Link to `next dev` docs.
Clarify that this will use the production environment. Link to `next dev` docs.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was reading the blitz command docs and got confused by the part about the environment. All docs used
blitz dev -e stagingas the first big block of code. I think this was a copy paste error. I removed it as part of these changes.Other changes:
blitz buildThe code hard codes the
env. The docs now show that. They also reference the--inspectwhich is something the code allows.blitz start,blitz devBoth commands are meant to run as production or development. Therefore the reference to change the environment is confusing – that is what the other command is there for.
The part I don't get is, why the code changes based on the
NODE_ENV(https://github.com/blitz-js/blitz/blob/main/packages/blitz/src/cli/commands/next/dev.ts#L25 and https://github.com/blitz-js/blitz/blob/main/packages/blitz/src/cli/commands/next/start.ts#L25).All pages now link to the next JS docs for the corresponding command.