Melvynx/saveit.now / .agents/skills/ns-add-documentation
ns-add-documentation
VerifiedAdd 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`.
Add Documentation — NowStack Mobile
-
Scope it before writing. Answer:
- Who reads this — agent, developer, release operator, or support?
- Which surface —
convex/,web-app/,mobile-app/, store release, or sharedsite-config.ts? - What should the reader do differently after reading it?
- Which command or file proves the guidance is still current?
-
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>.mdfromtemplates/doc-template.md. -
Fill it in — replace every
TODOwith real paths, exact steps, and real verification commands. -
Make it discoverable — link the new doc where a reader would look for it (a sibling doc, or the relevant
.agents/rules/*.md/AGENTS.mdentry). An unlinked doc is a doc nobody finds. -
Verify the commands you wrote actually run (see below), then report the path.
Feature Or Workflow
Purpose
What this solves and when it applies.
Relevant Files
path/to/real/file
Workflow
- 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
<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>
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 466k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |