Add pnpm run dev in the root package.json for docs #12

Open
opened 2026-07-22 22:32:04 +00:00 by Ninosaurier · 2 comments
Owner

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" } ```
Ninosaurier added the Kind/EnhancementPriority/MediumCommunity/Good First Issue labels 2026-07-22 22:32:04 +00:00
Ninosaurier referenced this issue from a commit 2026-08-01 21:42:07 +00:00
Ninosaurier added reference docs/review-readme 2026-08-01 21:43:57 +00:00
Ninosaurier self-assigned this 2026-08-01 21:46:24 +00:00
Author
Owner

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.
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.
Author
Owner

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.
Sign in to join this conversation.