跳到正文
cccskills
免费在 GitHub 公开

publish-docs

Sync the company's published docs site to match what shipped. For in-repo docs use /document-release.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core星标 90(GitHub 90 + cccskills 0)

实测评分 未实测

查看安装方法

包含的文件(2)

  • SKILL.md5.6 KB
  • agents/openai.yaml135 B

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Publish Docs

Sync the active company's published documentation site — the standalone, user-facing docs site that lives in its own repo and deploys to its own URL (e.g. docs.{company}.com built from repos/public/{company}-docs) — so it reflects what actually shipped.

This command is a company-agnostic dispatcher. It does not itself know how any one company builds or publishes its docs site. It resolves the active company, finds that company's docs-site sync skill, and runs it foreground. Companies without a published docs site are a clean no-op.

Scope boundary (read this first)

There are two distinct documentation layers, and this command owns exactly one:

LayerOwnerWhat it touches
In-repo docsdocument-releaseREADME.md, CLAUDE.md, architecture docs, INDEX.md, CHANGELOG — docs that live alongside the code
Published docs sitethis skillthe standalone docs-site repo that builds and deploys to a public URL

document-release never reaches into a separate docs-site repo. This command is that missing half. /ship runs both, in order, as its final foreground step.

When NOT to run

  • The change did not ship anything material to a product users see (internal refactor, HQ-core plumbing, tooling). Publishing docs for a no-op change is churn.
  • No company is resolvable. This command requires a company anchor; it never guesses across tenants.

Step 0: Resolve Company

  1. Bind the active company the same way every HQ command does: explicit mention → cwd → the repo's owning company in companies/manifest.yaml → handoff. Never guess or cross tenants.
  2. Announce: Publishing docs site for: {company name}

If no company resolves, stop and say so — do not proceed unanchored.

Step 1: Discover the Company's Docs-Site Sync Skill

A company opts in to docs-site publishing in one of two ways. Check in this order and use the first that matches:

  1. Explicit manifest declaration. Read the company's entry in companies/manifest.yaml. If it declares:

    {co}:
      docs_site:
        sync_skill: {co}:sync-docs   # skill to invoke
        repo: repos/public/{co}-docs # optional, informational
        url: https://docs.example.com # optional, informational
    

    use docs_site.sync_skill as the skill to run.

  2. Convention. If no manifest declaration, check whether the company ships a docs-site sync skill by convention at companies/{co}/skills/sync-docs/SKILL.md. If present, the skill to run is {co}:sync-docs.

  3. Neither → clean no-op. If the company declares no docs_site.sync_skill and has no companies/{co}/skills/sync-docs/, report and exit successfully:

    publish-docs: no published docs site configured for {company name} — skipping.
    (To enable: add a `sync-docs` skill under companies/{co}/skills/, or a
     docs_site.sync_skill entry in companies/manifest.yaml.)
    

    Exit 0. This is the expected path for companies without a public docs site, and it is why /ship can call this unconditionally without going red.

Do NOT fabricate or hardcode any specific company's skill name. The only company-specific knowledge lives in that company's own skill/manifest.

Step 2: Dispatch (foreground)

Invoke the resolved docs-site sync skill in the foreground via the Skill tool (e.g. Skill(skill: "{co}:sync-docs")). Never background this — the whole point is that published docs are live and verified before the caller reports done.

The company skill owns everything site-specific: deciding whether the shipped change is material to the public docs, editing the affected pages, building the docs-site repo (anchored with an explicit absolute cd /abs/repo && ... per hq-anchor-repo-build-cwd), publishing, and verifying the pages live. This command does not second-guess that skill's build/publish steps.

Pass through any context the caller provided (the shipped diff, PR refs, project slug) so the company skill can judge materiality without re-deriving it.

Step 3: Report

Relay the company skill's outcome in one plain line, keeping any live URL it returns:

Docs site: {published — <url> | no material change, nothing to publish | skipped — none configured}

If the company skill failed, surface the failure plainly — do NOT swallow it. When called from /ship, a docs-site failure is reported but does not retroact the ship's merged/deployed/smoked status (docs are not in ship's done-criteria); the caller decides whether to heal or hand off the docs failure.

Rules

  • Company isolation — resolve exactly one company; only touch that company's docs site, repo, and credentials. Cross-company docs publishing is a category-1 bug.
  • Foreground only — never dispatch the docs-site sync as a background job.
  • Dispatcher, not implementer — all site-specific build/publish/verify logic lives in the company's own skill. Keep this command generic.
  • Clean no-op for unconfigured companies — absence of a docs site is a success, not an error, so callers (like /ship) stay green.
  • Anchor builds — if you ever run a build directly, anchor it with an explicit absolute cd /abs/repo && ... (policy hq-anchor-repo-build-cwd); a green build is not proof you built the right repo.
  • Never guess credentials or targets — read them from the resolved company's policies/manifest only.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

accept

免费

Accept HQ membership invites from a magic link or raw token.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core902026年10月26日 更新

adr

免费

Capture qualifying architecture decisions as ADRs in the right HQ or repo location.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core902026年10月26日 更新

Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking screenshots, extracting data, testing web apps, or automating any browser task. Triggers include requests to "open a website", "fill out a form", "click a button", "take a screenshot", "scrape data from a page", "test this web app", "login to a site", "automate browser actions", or any task requiring programmatic web interaction.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core902026年10月26日 更新

architect

免费

Find shallow modules and propose deepening refactors, ranked with file refs; never edits code. Use when code is hard to change or planning a refactor.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core902026年10月26日 更新

Generate dark ASCII banner graphics for HQ and social launch assets.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core902026年10月26日 更新

Compare approaches to best-in-class prior art, merge existing work, verify cruft removal, and recommend the most durable design before PRD work.

中文简介正在准备中。当前显示原文说明。

indigoai-us/hq-core902026年10月26日 更新

查看 indigoai-us 的全部技能

报告此技能的问题