Currently, starting the documentation site requires navigating into the /docs directory or manually targeting the Astro project. To streamline the local development workflow, we need a centralized shortcut command in the root repository.
Following our existing pattern for unit tests ("test:unit": "pnpm --filter luna-charts test:unit") we should expose the Astro development server directly from the workspace root.
Outcome
What should happen:
Running pnpm run dev from the repository root successfully launches the Astro local development server for the documentation.
The command targets and executes the dev script inside the /docs workspace project.
Proposed Solution / Changes:
Add the shortcut script to the root package.json under the scripts object:
"scripts":{"dev":"pnpm --filter docs dev"}
Currently, starting the documentation site requires navigating into the `/docs` directory or manually targeting the Astro project. To streamline the local development workflow, we need a centralized shortcut command in the root repository.
Following our existing pattern for unit tests `("test:unit": "pnpm --filter luna-charts test:unit")` we should expose the Astro development server directly from the workspace root.
## Outcome
### What should happen:
- Running `pnpm run dev` from the repository root successfully launches the Astro local development server for the documentation.
- The command targets and executes the `dev` script inside the `/docs` workspace project.
### Proposed Solution / Changes:
Add the shortcut script to the root `package.json` under the scripts object:
```json
"scripts": {
"dev": "pnpm --filter docs dev"
}
```
Implemented the root documentation development command locally.
Changes:
Added a root-level shortcut to start the Astro documentation site.
pnpm run docs now starts the /docs workspace development server.
Verified locally:
Documentation starts successfully from the repository root.
Working on this issue.
Implemented the root documentation development command locally.
Changes:
- Added a root-level shortcut to start the Astro documentation site.
- `pnpm run docs` now starts the `/docs` workspace development server.
Verified locally:
- Documentation starts successfully from the repository root.
Implemented as pnpm run docs instead of pnpm run dev. Chose docs
as the name because it's unambiguous at the root level — a bare dev
could later be confused with a dev script for the library itself or
for Storybook. Functionality-wise this resolves the issue, so closing.
Implemented as `pnpm run docs` instead of `pnpm run dev`. Chose `docs`
as the name because it's unambiguous at the root level — a bare `dev`
could later be confused with a dev script for the library itself or
for Storybook. Functionality-wise this resolves the issue, so closing.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Currently, starting the documentation site requires navigating into the
/docsdirectory or manually targeting the Astro project. To streamline the local development workflow, we need a centralized shortcut command in the root repository.Following our existing pattern for unit tests
("test:unit": "pnpm --filter luna-charts test:unit")we should expose the Astro development server directly from the workspace root.Outcome
What should happen:
pnpm run devfrom the repository root successfully launches the Astro local development server for the documentation.devscript inside the/docsworkspace project.Proposed Solution / Changes:
Add the shortcut script to the root
package.jsonunder the scripts object:Working on this issue.
Implemented the root documentation development command locally.
Changes:
pnpm run docsnow starts the/docsworkspace development server.Verified locally:
Implemented as
pnpm run docsinstead ofpnpm run dev. Chosedocsas the name because it's unambiguous at the root level — a bare
devcould later be confused with a dev script for the library itself or
for Storybook. Functionality-wise this resolves the issue, so closing.