Pets

Appearance

Pets Docs ​

This folder contains the source Markdown for the Pets documentation site. The local docs preview uses VitePress, matching the setup used by Gittles.

Local Development ​

Install repository dependencies from the repo root:

bash
bun install

Start the local docs server:

bash
bun run docs

Open the printed local URL, usually http://localhost:5173.

Production Build ​

Build the static site:

bash
bun run docs:build

Preview the built output locally:

bash
bun run docs:preview

The build output is written to:

text
docs/.vitepress/dist

The VitePress build also emits LLM-friendly artifacts:

text
docs/.vitepress/dist/llms.txt
docs/.vitepress/dist/llms-full.txt

Documentation Structure ​

text
docs/
├── .vitepress/          # VitePress config and theme
├── index.md             # VitePress home page
├── INSTALL.md           # Installation guide
├── configuration.md     # Configuration guide
├── api-reference.md     # API reference
├── exec.md              # Direct tool execution
├── redo.md              # Replay last execution
├── factory.md           # Factory pattern docs
├── patterns.md          # Patterns guide
├── best-practices.md    # Best practices
├── testing.md           # Testing guide
├── deployment/          # Deployment guides
├── generation/          # Code generation guides
├── quickref/            # Quick reference
└── examples/            # Examples

Writing Documentation ​

  • Use Markdown files for pages that should render in VitePress.
  • Add new pages to docs/.vitepress/config.ts when they should appear in the sidebar.
  • Keep page links extensionless, for example /configuration.
  • Run bun run docs:build before publishing docs changes.