跳到正文
cccskills
免费在 GitHub 公开

docs-authoring

Use when a change affects user-visible behavior at docs.chronote.gg and needs public documentation. Covers where docs live (apps/docs-site vs docs/), authoring checklist, yarn docs:check, and Algolia config. Trigger when the user mentions docs, release notes, what's-new, or user-facing PR changes.

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

查看安装方法

包含的文件(1)

  • SKILL.md1.7 KB

SKILL.md(原文)

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

Docs Authoring Workflow

Use this skill when a change affects user-visible behavior and needs public documentation at docs.chronote.gg. Repo-specific workflow for creating or updating docs in apps/docs-site.

This is the Claude Code mirror of .opencode/skills/docs-authoring/SKILL.md and applies the same standing rules.

Standing rules

  • Public product docs live in apps/docs-site.
  • Internal engineering notes and runbooks stay in docs/.
  • User-facing PRs must include a docs delta, unless docs-exempt is explicitly used.
  • Keep docs concise, actionable, and user-oriented.

Authoring checklist

  1. Identify user-facing behavior changes from code and issue scope.
  2. Update or add the relevant docs page in apps/docs-site/docs/.
  3. Add or update links in sidebars/navigation when needed.
  4. For notable releases, update apps/docs-site/docs/whats-new/index.md.
  5. Run docs validation:
yarn docs:check
  1. Confirm no broken links and no stale setup instructions.

Style expectations

  • Use short headings and direct language.
  • Prefer checklists and task-oriented steps.
  • Avoid internal implementation details unless they are required for users.
  • Keep examples realistic and minimal.

Search and deployment notes

  • Algolia config uses DOCS_ALGOLIA_APP_ID, DOCS_ALGOLIA_API_KEY, and DOCS_ALGOLIA_INDEX_NAME.
  • If Algolia is not configured, local search can be used as the temporary fallback.

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

Analyze Chronote product adoption with PostHog and Langfuse, including active users, meetings, feature usage, AI telemetry, and privacy-safe resolution of active Discord guild IDs to live server names.

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

Chronote-gg/Chronote42026年10月19日 更新

Investigate errors, incidents, or product ideas using both internet research and repo-wide codebase research, then propose a concrete changeset plan with clarifying questions before any implementation. Use when a user asks to investigate, root-cause, or plan changes, or when an Issue or PR is referenced and needs a plan.

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

Chronote-gg/Chronote42026年10月19日 更新

Query aggregate Langfuse cost, volume, latency, and model telemetry efficiently with Metrics API v2. Use for dashboards, rollout checks, usage summaries, and cost or latency comparisons; use Observations API v2 instead when individual rows are actually required.

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

Chronote-gg/Chronote42026年10月19日 更新

Configure and debug MCP servers for OpenCode, Codex CLI, and Claude Code, including auth headers, scope, and validation checks. Use when MCP tools fail to connect or when adding a new MCP server.

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

Chronote-gg/Chronote42026年10月19日 更新

Configure and debug MCP servers for Claude Code, OpenCode, and Codex CLI, including auth headers, scope, and validation checks. Use when MCP tools fail to connect, when an MCP server returns 401/404/HTML, or when adding a new MCP server to this repo.

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

Chronote-gg/Chronote42026年10月19日 更新

Use every time you push a commit to an active pull request, to verify the PR is truly stable before reporting merge readiness. Covers the post-push wait window, AI review audit (Copilot/Greptile/Codex), and the gh commands to snapshot PR state. Trigger on "I pushed" or "is the PR ready to merge".

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

Chronote-gg/Chronote42026年10月19日 更新

查看 Chronote-gg 的全部技能

报告此技能的问题