docs: documentation website (incubating)#21
Merged
Merged
Conversation
vitepress + @btravstack/theme, cyan accent, the liftoff-beet mark, an under-construction strip (worker beet) since the packages are private while the api settles. deploys to github pages on push.
There was a problem hiding this comment.
Pull request overview
Adds an incubating VitePress-based documentation website for the start monorepo, including a new docs/ workspace, theme wiring, content pages, and a GitHub Pages deployment workflow.
Changes:
- Introduces a new
docs/PNPM workspace using VitePress +@btravstack/theme, with initial guide content and site styling/assets. - Wires docs into repo tooling (Turbo task config, Knip workspace config, PNPM catalog + release-age exclusions).
- Adds a GitHub Actions workflow to build and deploy the docs site to GitHub Pages, and links the docs from the README.
Reviewed changes
Copilot reviewed 15 out of 26 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| turbo.json | Adds a per-package Turbo build task configuration for the docs output directory. |
| README.md | Links to the published documentation site. |
| pnpm-workspace.yaml | Adds the docs workspace and catalogs VitePress/theme deps; adjusts release-age exclusions. |
| pnpm-lock.yaml | Locks new docs-related dependencies (VitePress/theme and transitive deps). |
| knip.json | Adds Knip project configuration for the docs workspace. |
| docs/package.json | Introduces the docs package with VitePress scripts and dev dependencies. |
| docs/index.md | Adds the docs home page (hero, features, and incubating banner). |
| docs/guide/the-idea.md | Adds initial guide content (“The idea”). |
| docs/guide/status.md | Adds “Status” page describing incubation posture. |
| docs/guide/packages.md | Documents the (currently private) package set at a high level. |
| docs/guide/hosts.md | Documents host concepts and the transport matrix. |
| docs/guide/examples.md | Documents examples and their integration-test posture. |
| docs/.vitepress/config.ts | Adds VitePress site configuration (base, nav/sidebar, head tags, sitemap, SSR bundling). |
| docs/.vitepress/theme/index.ts | Wires @btravstack/theme as the docs theme entrypoint. |
| docs/.vitepress/theme/custom.css | Sets the accent token and adds site-specific home/hero/WIP styling. |
| docs/public/.nojekyll | Ensures GitHub Pages doesn’t apply Jekyll processing. |
| docs/public/logo.svg | Adds site logo SVG. |
| docs/public/logo-light.svg | Adds light-scheme logo SVG. |
| docs/public/logo-dark.svg | Adds dark-scheme logo SVG. |
| docs/public/beet-worker.svg | Adds “under construction” worker-beet SVG used on pages. |
| docs/public/icons/spine.svg | Adds feature icon SVG. |
| docs/public/icons/hosts.svg | Adds feature icon SVG. |
| docs/public/icons/flask.svg | Adds feature icon SVG. |
| docs/public/icons/contract.svg | Adds feature icon SVG. |
| .github/workflows/deploy-docs.yml | Adds a GitHub Pages deployment workflow for the docs site. |
Files not reviewed (1)
- pnpm-lock.yaml: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the docs site at https://btravstack.github.io/start/ — VitePress on `@btravstack/theme` 1.6.1, the BtravStack one-knob accent contract (`--accent: #22B8CF`, start's cyan).
Verified locally: build passes, dark + light render, lint/format/knip clean.