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

Improve docs for blitz start, blitz dev, blitz build #804

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

tordans
Copy link
Contributor

@tordans tordans commented Jan 4, 2023

I was reading the blitz command docs and got confused by the part about the environment. All docs used blitz dev -e staging as 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 build

The code hard codes the env. The docs now show that. They also reference the --inspect which is something the code allows.

blitz start, blitz dev

Both 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.

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.
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.
@vercel
Copy link

vercel bot commented Jan 4, 2023

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

Name Status Preview Updated
blitzjs-com ✅ Ready (Inspect) Visit Preview Jan 4, 2023 at 4:20PM (UTC)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants