跳到正文
cccskills
免费在 GitHub 公开

ns-add-documentation

Add or update NowStack Mobile docs in docs/. Use when documenting architecture, release workflows, Convex/web/mobile patterns, setup, APIs, or tooling — or via `/ns docs`.

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

实测评分 未实测

查看安装方法

包含的文件(4)

  • SKILL.md3.5 KB
  • references/documentation-format.md1.2 KB
  • scripts/create-doc.sh1.5 KB
  • templates/doc-template.md204 B

SKILL.md(原文)

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

Add Documentation — NowStack Mobile

<objective> Write or update repository docs in `docs/`, in this repo's house style: plain Markdown, grounded in real files and commands. This is NOT the public MDX docs tree from NowStack SaaS — no `/docs/[slug]` route, no MDX components. </objective> <workflow> 1. **See what already exists** (never assume — the doc set changes): ```bash ls docs/ docs/templates/ ``` Update an existing doc if one already covers the topic; only create a new file when nothing fits.
  1. Scope it before writing. Answer:

    • Who reads this — agent, developer, release operator, or support?
    • Which surface — convex/, web-app/, mobile-app/, store release, or shared site-config.ts?
    • What should the reader do differently after reading it?
    • Which command or file proves the guidance is still current?
  2. Create from the template so frontmatter and structure stay consistent:

    .agents/skills/ns-add-documentation/scripts/create-doc.sh <filename> "<title>" "<description>"
    # e.g. create-doc.sh web-app-routing "Web App Routing" "TanStack Start route conventions"
    

    Writes docs/<filename>.md from templates/doc-template.md.

  3. Fill it in — replace every TODO with real paths, exact steps, and real verification commands.

  4. Make it discoverable — link the new doc where a reader would look for it (a sibling doc, or the relevant .agents/rules/*.md / AGENTS.md entry). An unlinked doc is a doc nobody finds.

  5. Verify the commands you wrote actually run (see below), then report the path.

    </workflow>
<structure> ```md --- title: "Feature Or Workflow" description: "One sentence explaining the doc" ---

Feature Or Workflow

Purpose

What this solves and when it applies.

Relevant Files

  • path/to/real/file

Workflow

  1. Exact step.

Verification

Commands or manual checks that prove it works.

Notes

Caveats, secrets to keep out of git, release constraints.

Deeper conventions: [references/documentation-format.md](references/documentation-format.md).
</structure>

<rules>
- Ground every claim in a real repo file or command — no invented paths, routes, or flags.
- Commands must match `.agents/rules/development-commands.md`.
- Convex docs: state that agents must read `convex/_generated/ai/guidelines.md` before editing `convex/`.
- Cross-surface product/URL/auth/payment facts come from `site-config.ts`.
- Release docs: keep `asc`/`gpc`/screenshot conventions, and keep iOS/Android/store secrets out of git.
- Don't reintroduce the SaaS web-docs tree: no MDX-only components, no `/docs/[slug]`, no NowStack SaaS org routes.
</rules>

<verification>
Run only the checks matching the doc's surface:

```bash
npx convex dev --once               # Convex docs compile against the schema
cd web-app && npm run typecheck     # web docs
cd web-app && npm run build
cd mobile-app && npx tsc --noEmit   # mobile docs
cd mobile-app && npm run lint
cd mobile-app && npm run screenshots:store   # store/screenshot docs
</verification>

<success_criteria>

  • The doc lives in docs/, references only real repo paths, and its commands run.
  • It's linked from somewhere a reader will actually look.
  • No stale public-docs-tree, MDX-only, /docs/[slug], or NowStack SaaS assumptions remain. </success_criteria>

评价

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

评论

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

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

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

0 / 1000 字

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

同一仓库的技能

Complete guide for building beautiful apps with Expo Router. Covers fundamentals, styling, components, navigation, animations, patterns, and native tabs.

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

Melvynx/saveit.now322026年10月24日 更新

convex

免费

Routes general Convex requests to the right project skill. Use when the user asks which Convex skill to use or gives an underspecified Convex app task.

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

Melvynx/saveit.now322026年10月24日 更新

Use when optimizing Convex database read bandwidth, documents-read cost, query indexes, full-table scans, function-level usage dashboard findings, or code that uses .filter(), unbounded .collect(), N+1 reads, or expensive reactive Convex queries.

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

Melvynx/saveit.now322026年10月24日 更新

Build reusable Convex components with isolated tables and app-facing wrappers. Use for defineComponent, app.use, ComponentApi, or shared backend modules.

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

Melvynx/saveit.now322026年10月24日 更新

Plan safe Convex schema and data migrations. Use for widen-migrate-narrow rollouts, backfills, breaking field changes, table splits, or failed schema deploys.

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

Melvynx/saveit.now322026年10月24日 更新

Audit Convex performance for hot reads, write contention, subscriptions, function limits, OCC conflicts, latency, read amplification, and expensive reactive queries.

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

Melvynx/saveit.now322026年10月24日 更新

查看 Melvynx 的全部技能

报告此技能的问题