证据快照复核于 2026-08-30GitHub 数据核对日期: 2026-08-21
来源已审查独立 Skill文件与文档

dsh-doc-site-sync

用于同步文档站点的指导。

快速了解

它能做什么

用于同步文档站点的指导。

本站提供的是中文说明,不代表该项目或 Plugin 自身提供中文界面;语言支持请以上游文档为准。

能力
文件与文档文档工作流自动化

选择前先看

该技能提供用于同步文档站点的指导

适合谁

需要documentation能力的 DSH 用户。

常见任务

  • 用于文档站同步相关的documentation工作流。
  • 决定是否适合你的 Profile 前先查看固定版本的仓库证据。

权限与数据

本次未测试运行时行为;宿主访问范围取决于 DSH 集成方式和声明的依赖项。

权限
  • 将技能加入宿主技能集合。
数据处理
  • 本次未测试运行时数据处理。
外部服务
  • 可能使用固定仓库声明的依赖项或服务。
凭据
  • 现有证据没有确认凭据要求。

局限

  • 本次未测试运行时安装和执行。
  • 描述基于固定版本的仓库证据。

DSHub 已核对

  • 证据中固定了源码仓库 commit。

DSHub 未核对

  • 本次未测试运行时安装、执行和兼容性。
  • 不表示任何安全认证。

固定版本安装

主要操作

这个独立 Skill没有 DSH Plugin 安装操作,请根据源码文档使用真实交付方式。

访问源码项目

维护者原文

Skill 使用说明

查看 commit effbc05 对应的 SKILL.md
维护者编写的上游内容原文于 2026/8/29.agents/skills/dsh-doc-site-sync/SKILL.md 获取,正文和仓库相对媒体固定到 commit effbc051049c,内容哈希为 d2fa857efa06。以下是未经 DSHub 翻译的上游原文,语言可能与当前页面不同;第三方托管的 badge 可能独立更新。

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

  • Read docs/AGENTS.md and use dsh-doc-standards when deciding where content belongs or changing product documentation prose.
  • For an edited bilingual source, follow the lightweight routine path in docs/AGENTS.md and the pairing contract; never invoke the extended translation skill automatically.
  • Read the current DocsPage type and entries in website/docs.ts before changing the manifest; do not rely on a remembered field set.
  • Read website/.vitepress/config.ts before adding a new section, sidebar collection, locale, or top-level navigation item.

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 expands what the site publishes.

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.
  • Cross-page fragments use the English GitHub heading id as their canonical id. If an authored heading emits a different VitePress id, place an explicit <a id="..."></a> immediately before it; add generated aliases in the owning generator.

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

If Markdown link checks pass but the site build reports a missing fragment, follow the verify-doc-site-fragments source and target paths. Preserve the English GitHub id with an explicit alias in authored Markdown or in the owning generator.

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.

有意识地管理

安装与管理

前置条件与目标 Profile

目标 没有原生 DSH Profile 目标。

交付方式 Skill 文件 — https://github.com/hust-open-atom-club/oh-dsh

兼容性与访问范围

not_runtime_tested not tested

检查兼容性证据

风险事实

installer-risk

A destructive recursive-delete pattern was detected in the installer script; do not run it without human review.

证据
installer-risk

A destructive recursive-delete pattern was detected in the installer script; do not run it without human review.

证据
installer-risk

A destructive recursive-delete pattern was detected in the installer script; do not run it without human review.

证据
distribution-signal

The npm distribution signal is incomplete or differs from the pinned source; review it before use.

证据
distribution-signal

The npm distribution signal is incomplete or differs from the pinned source; review it before use.

证据
distribution-signal

The npm distribution signal is incomplete or differs from the pinned source; review it before use.

证据
证据与编辑审查Manifest、Bundle patch、分发与新鲜度

不可变证据

审查状态与源码活动

人工已批准

在核对来源内容和不可变发布记录后,已由人工批准发布。AI 参与了内容草稿生成,最终发布决定由人工完成。

人工审查于 2026/8/29 UTC 15:26GitHub 事实核对日期: 2026/8/29 UTC 15:11

自当前证据基线以来,没有记录到重要源码变化。

下一步

比较生态 Artifact 类型

订阅重要变化: dsh-doc-site-sync