跳到正文
cccskills
免费在 GitHub 公开

docs

Decide which family a doc belongs to before drafting — SDK/developer, user/product, or working-group (WG) — since family sets the audience, home, and tone. Use when creating, moving, or restructuring docs, when unsure which directory a doc belongs in, or when a request says "document this" / "write docs for X" without naming the kind. Routes to the specialized skill for each family.

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

集成工具Figma
查看安装方法

包含的文件(1)

  • SKILL.md8.1 KB

SKILL.md(原文)

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

Docs

Documentation in Grida is not one thing. Before drafting, name the family — because the family decides the audience, the home directory, the tone, and which skill governs the rest. Writing the right content in the wrong family (a spec dump in a user guide, a marketing tone in an RFC) is the most common and most expensive docs mistake, because it is invisible until someone reads it for the wrong reason.

/docs/** is the source of truth, synced to /apps/docs/docs/** at build and published at grida.co/docs. Edit the root /docs, never the synced copy. The operational rules that apply to every family — taxonomy (draft / unlisted / doc_tasks), frontmatter, MDX safety (format: md), _history/, the structure table — live in docs/AGENTS.md. Read it once; this skill does not repeat it.

The three families

FamilyAudienceHomeCharacterGoverning skill
SDK / developerengineers (and, implicitly, agents) consuming a package or APIpackages/<pkg>/docs/ for spec-only; docs/reference/** for stable referencestechnical, example-dense, low-visual, precisethis skill (below)
User / producthumans using a Grida productdocs/editor/**, docs/forms/**, docs/platform/**, docs/with-figma/**, …content-rich, screenshots, SEO-friendly, task-orientedcanvas editor (docs/editor/) → docs-canvas; cross-cutting → seo + docs-svg-kit; other surfaces have no dedicated skill yet — use docs/AGENTS.md + seo
WG / research / RFC-RFDcontributors and maintainers reasoning about why and whatdocs/wg/**spec-rich, language-agnostic, code-agnostic, factualdocs-wg

If the request fits one family cleanly, hand off to its governing skill and stop reading here. The rest of this page covers the routing edges and the SDK family (which has no skill of its own).

Routing — which family is this?

Ask, in order:

  1. Is it about why a thing is designed the way it is, or what a feature/spec should be — independent of any one implementation? → WG. Go to docs-wg.
  2. Is the reader a person trying to use a shipped product? → User docs. Content-rich and SEO-aware. For the canvas editor (docs/editor/) use docs-canvas; for other surfaces (forms, platform, with-figma) there is no dedicated skill yet — follow docs/AGENTS.md and seo. docs-svg-kit covers SVG figures for any of them.
  3. Is the reader an engineer (or agent) trying to consume a package or API correctly? → SDK docs (below).

The boundaries are real, not bureaucratic:

  • Architecture / design rationale never goes in user docs. It belongs in WG. (docs-canvas enforces the same boundary from its side.)
  • A WG doc is not an SDK doc. WG says "this is what the feature is and why"; SDK says "this is the API and how to call it." A WG doc that drifts into API signatures has become an SDK doc in the wrong place — see docs-wg on staying code-agnostic.
  • Implementation-binding specs live with the code, not in docs/wg. A spec that maps a universal contract onto one codebase — the concrete data a structure holds, this build's keymap, the contract→code mapping — is code-specific. It belongs in the package or crate's own docs/, next to what it binds, so docs/wg can stay code-agnostic. It is neither a WG doc (too code-specific) nor an SDK doc (not for external consumers) — its home is the code.
  • A product that lives in another Grida repo authors its docs there. FX's guide is written in gridaco/fx and published at grida.co/docs/fx as a docs source: its pages and assets never enter this repo, only a pinned commit (apps/docs/sources.json). Edit such docs in their repo, follow its asset rules there, and never copy them into /docs. Private products are the exception: their public docs are written here.
  • Plans, TODO lists, and conversational logs are not docs of any family. Plans live in untracked *.plan.md files (gitignored); they do not belong under docs/.

SDK / developer docs

SDK docs explain how to consume a package or API. They optimize for an engineer (and, without ever saying so, for an agent) who needs to get a call right on the first try.

Where they live:

  • packages/<pkg>/docs/ — when the docs are spec-heavy and not visually rich. Co-locating with the package keeps the contract next to the code it describes and versioned with it. (Precedent: packages/grida-svg-editor/docs/.) A package's README.md and AGENTS.md are the entry points; docs/ holds the deeper material.
  • docs/reference/** — for stable, cross-package technical references, glossaries, and specs that deserve a place on the published site. This tree is actively maintained alongside docs/wg/\*\*.

What good SDK docs look like:

  • Example-dense. Every non-trivial API earns a short, runnable example. Examples carry more than prose for a consumer.
  • Technical and precise about types, contracts, and edge cases — light on screenshots and marketing.
  • Good for agents by being good, period. Do not write "for AI" — a clear, complete, example-backed reference is what an agent needs and what a human needs. The two goals do not diverge.
  • Honest about stability. Mark experimental surfaces; an SDK doc that oversells a shaky API costs its readers time.

Related skills

docs-wg (WG authoring doctrine), docs-canvas (canvas/editor user docs), seo (frontmatter + search), links (how to write any link), grounding (find/reconcile the authoritative doc before editing). Operational taxonomy and frontmatter: docs/AGENTS.md.

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

Grida AI agent system work: `@grida/daemon` (DaemonServer, loopback HTTP perimeter, files/workspaces, secrets store, daemon discovery) and `@grida/agent` (the agent tenant: sessions, providers/BYOK, runtime/tool execution, skills discovery, prompts, tiers, sandbox hosts). Use for `packages/grida-daemon/**`, `packages/grida-ai-agent/**`, desktop sidecar protocol changes, agent chat transport, and bugs in agent state or streams. For pure Electron window, preload, menu, deep-link, or CDP work, use `desktop`.

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

gridaco/grida26862026年10月19日 更新

ai-models

免费

Research, compare, and update shared AI model JSON for TypeScript, web, and Rust consumers. Covers text model tiers, image and video generation models, image tool models, release provenance, pricing data sourcing, and product-side catalogue cost estimates. Use when bumping model versions, adding new models, updating pricing, or auditing model specs against provider documentation.

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

gridaco/grida26862026年10月19日 更新

React-specific code shape in the Grida editor. Hooks cannot be tested or benchmarked and silently break tuned UX under layered composition, so they are barred from the engine and main system — load-bearing logic lives in classes and namespaces, hooks only as thin edge wires. `data-testid` follows component-root discipline: one per significant component, not scattered. Use when authoring React in `editor/grida-canvas-react/`, `editor/components/`, `editor/scaffolds/`, or `editor/app/*`.

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

gridaco/grida26862026年10月19日 更新

code-ts

免费

TypeScript code shape inside a well-named module — taste, not lint. Prefer one class or namespace per file (the unit a test targets) over scattered free exports; consolidate related code, don't fragment. The unit of code should be the unit of spec. Use when authoring TS in `editor/grida-canvas*`, `editor/lib/`, or `packages/*`. Sibling to the `naming` skill; React-specific shape lives in `code-react`.

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

gridaco/grida26862026年10月19日 更新

database

免费

Use BEFORE editing any file in `supabase/migrations/` or `supabase/schemas/`, OR when the user runs a `/database` subcommand (`compact local migration`, `rls scenarios`, `align`). Encodes the three contracts that protect the Grida database layer: applied migrations are immutable, RLS implementation mirrors tests (never the reverse), `schemas/*.sql` is the human-readable end-state. Companion to `supabase/AGENTS.md` (RLS, grants, security boundaries).

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

gridaco/grida26862026年10月19日 更新

desktop

免费

Grida Desktop Electron shell and release-impact work: BrowserWindow, preload, `window.grida`, menus, protocol/deep links, file associations, Forge, path-scoped bridge security, Electron-only UI bugs, and CDP / Playwright verification. Use for `desktop/`, `editor/app/desktop/**`, `editor/scaffolds/desktop/**`, `editor/lib/desktop/**`, `/desktop/*` CSP, GRIDA-SEC-004, and deciding whether linked-package or hosted-renderer changes require a native Desktop version bump or coordinated release. For implementing daemon/agent-tenant core behavior, use `agent-system` as well.

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

gridaco/grida26862026年10月19日 更新

查看 gridaco 的全部技能

报告此技能的问题