| name | dsh-doc-site-sync |
| description | Use when publishing, updating, moving, or removing DeepSeek Harness documentation website pages; editing website/docs.ts mappings or navigation; diagnosing a page missing from the VitePress site; fixing projected documentation links; or running the docs:dev, docs:check, and doc-sync workflow after website-content changes. |
Synchronizing the DeepSeek Harness Documentation Site
Keep repository Markdown as the only editable content source. Treat the website as a tested projection: website/docs.ts selects public pages, scripts/project-doc-site.ts rewrites them into the disposable website/.generated/ tree, and VitePress builds that tree.
Repository translations follow the sibling pairing contract: English foo.md, Chinese foo.zh.md, and foo.i18n.yaml live together. Never create zh-CN/ or other locale directories for website content. The site route trees are independent of that source layout: foo.zh.md projects to the root route and foo.md projects to the matching /en/ route.
Read the owning contracts
Classify the change
- Edit an already published page: change only its canonical Markdown source. Do not touch the manifest unless its route or navigation metadata changes.
- Publish a new page: create it in its owning
docs/ tier, then add one manifest entry.
- Rename, move, or remove a page: update the canonical file, manifest entry, and inbound repository links atomically. Remove stale manifest entries;
docs:check rejects missing sources.
- Publish a generated catalog: map the generated
docs/ file, but change its generator or source metadata rather than editing the catalog by hand.
- Change site structure: update the manifest for ordinary pages; update VitePress configuration only when the existing sidebar, section, or locale model cannot express the change.
Never edit or commit website/.generated/, website/.cache/, or website/.dist/. Except for website/AGENTS.md, never add Markdown under website/; locale and route directories such as website/zh-CN/, website/en/, and website/api/ are invalid source layouts. Keep generated catalogs under docs/, freshness-gate them there, and publish them through the manifest.
Add or update a manifest entry
Set every DocsPage field deliberately:
source: repository-relative canonical Markdown path. For a complete bilingual pair, add the English .md path through pairedPages(); it derives the sibling .zh.md, the content locales, and counterpart aliases.route: public VitePress path including the .md suffix.label: sidebar label, not necessarily the document H1.sidebar: reuse zh-guide, zh-develop, or en-docs unless the information architecture genuinely needs another collection.section: reuse an existing section when possible. If adding one, also place it in sectionOrder in the VitePress config.order: stable order within the section.sourceAliases: optional additional repository paths that should resolve to this page when links are projected. It does not create another public route.
Use mirroredPages() only for a source that intentionally falls back to the same available language in both route trees. Convert that entry to pairedPages() when its counterpart is added. Keep the manifest an explicit public allowlist. Do not publish RFCs, postmortems, testing guides, AGENTS.md, or maintainer workflows merely because they exist under docs/; add internal material only when the user explicitly changes the publication boundary.
Preserve link behavior
Write normal repository-relative Markdown links in canonical docs. The projector applies these rules:
- A target present in the manifest becomes a site-relative route.
- An existing target outside the manifest becomes a GitHub source link, including supported line suffixes.
- An image is the exception: its file is copied into the generated tree and referenced from there, so the site serves it regardless of repository visibility. It must be a regular file inside the repository.
- External URLs, site-absolute URLs, email links, and fragment-only links remain unchanged.
- A missing repository-relative target fails projection instead of silently producing a broken link.
Do not write website-specific routes into canonical Markdown just to satisfy VitePress. Use sourceAliases for directory-style repository links that should resolve to a mapped index page.
Preview and validate
Run local preview while editing:
pnpm docs:dev
The dev server watches mapped source files and reprojects them. Restart it after changing the manifest if the new source is not picked up automatically.
Run the focused website gate before treating the mapping as valid:
pnpm docs:check
Before committing a documentation-site change, run:
pnpm run doc-sync
pnpm run lint
git diff --check
Use dsh-pre-push-checks before pushing. Report the canonical files changed, manifest entries added or removed, public routes affected, and the exact checks run.
Keep deployment separate
Synchronizing content into the VitePress build does not publish it to the internet. Do not add GitHub Pages permissions, deployment workflows, custom domains, or public hosting unless the user explicitly requests deployment and confirms the hosting policy.
