Skip to content

Scaffold Starlight project with Tailwind, configure for GitHub Pages, and integrate with monorepo #1755

@kmcginnes

Description

@kmcginnes

Parent PRD

What to build

Create the Starlight docs project inside packages/docs/ using the official template, configure it for deployment to GitHub Pages, and wire it into the monorepo scripts.

End-to-end, this means:

  1. Run pnpm create astro --template starlight/tailwind to scaffold into packages/docs/
  2. Set package name to graph-explorer-docs in the generated package.json
  3. Configure astro.config.mjs:
    • site: "https://aws.github.io"
    • base: "/graph-explorer"
    • Sidebar with autogenerated groups for getting-started/, features/, guides/, references/
    • Tailwind via the template defaults (no custom theme yet)
  4. Create the directory structure under src/content/docs/ matching the target layout (empty placeholder index.md files are fine)
  5. Update root package.json:
    • Add "docs:dev": "pnpm --filter graph-explorer-docs dev"
    • Add "docs:build": "pnpm --filter graph-explorer-docs build"
    • Modify "build" and "dev" to exclude docs: --filter "!graph-explorer-docs"
  6. Verify pnpm install succeeds and pnpm docs:dev starts the dev server
  7. Verify pnpm docs:build produces output in packages/docs/dist/

Acceptance criteria

  • packages/docs/ exists with a working Starlight + Tailwind project scaffolded from the official template
  • pnpm docs:dev starts the dev server and renders the default Starlight page
  • pnpm docs:build exits 0 and produces static output
  • pnpm build and pnpm dev do NOT build/start the docs package
  • Astro config has correct site and base for GitHub Pages
  • Sidebar config has autogenerated groups for the four content directories

Blocked by

None - can start immediately

User stories addressed

  • User story 1 (search)
  • User story 2 (sidebar navigation)
  • User story 4 (dark/light mode)
  • User story 5 (local preview with hot reload)
  • User story 7 (monorepo conventions)
  • User story 9 (excluded from global build)
  • User story 10 (dedicated docs scripts)
  • User story 12 (landing page)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions