Add astro dev --background to CLI reference#13949
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thanks, the content looks good to me! My only concern is the organization:
We are mixing flags, subcommands and "general" information.
Because this is a reference page, maybe we can organize it this way to be consistent:
h2: astro dev
h3: Flags
h4: --background
h3: Subcommands
h4: astro dev stop
h4: astro dev status
h4: astro dev log
h5: Flags
h6: --follow
And "Background mode for AI coding agents" might be more helpful on https://docs.astro.build/en/guides/build-with-ai/ with a link to the reference for the available flags and subcommands?
Remains "Health endpoint"... unless you can think of another use case than AI, maybe this also belong to https://docs.astro.build/en/guides/build-with-ai/
|
|
||
| <p><Since v="7.0.0" /></p> | ||
|
|
||
| Starts the dev server as a detached background process. This is the flag that is used automatically when an AI agent is detected, but it can also be used manually. |
There was a problem hiding this comment.
The wording sounds a bit unnecessarily verbose ("this is the flag that is..."):
| Starts the dev server as a detached background process. This is the flag that is used automatically when an AI agent is detected, but it can also be used manually. | |
| Starts the dev server as a detached background process. This flag is provided automatically when an AI agent is detected. You can also use it manually: |
But, if we move "Background mode for AI coding agents" to the "Build with AI" page, the second sentence should probably link to /en/guides/build-with-ai/#background-mode-for-ai-coding-agents.
|
Ah, and it seems this is already a bit outdated, but it would be nice to update the latest code snippet in https://docs.astro.build/en/reference/cli-reference/#astro-commands to reflect what |
astro dev --background to CLI reference
- Restructure CLI reference with proper Flags/Subcommands headings - Move background mode and health endpoint to Build with AI guide - Update astro dev --help output to include new commands/flags - Add cross-references between the two pages
|
@ArmandPhilippot reorganized |
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Just a nit to keep the TOC consistent:
Otherwise, LGTM!
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
Description (required)
Adds documentation for the new
astro dev --backgroundflag andastro dev stop,astro dev status, andastro dev logssubcommands for managing background dev servers. Also documents the/_astro/statushealth endpoint and automatic agent detection behavior.Related issues & labels (optional)
This is for Astro 7.