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`.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 3.5 KB |
| references/documentation-format.md | markdown | 1.2 KB |
| scripts/create-doc.shexecutable | script | 1.5 KB |
| templates/doc-template.md | markdown | 204 B |
references/documentation-format.md
View on GitHub# Documentation Format
NowStack Mobile documentation lives in `docs/` as plain Markdown.
## File Naming
- Use kebab-case filenames.
- Use `.md`.
- Put templates or machine-readable examples under `docs/templates/`.
## Frontmatter
Keep frontmatter small:
```md
---
title: "Short Title"
description: "One sentence summary"
---
```
## Recommended Sections
- `Purpose`: when the doc applies and why it exists.
- `Relevant Files`: concrete repo paths.
- `Workflow`: exact steps, written for agents and developers.
- `Verification`: commands or manual checks.
- `Notes`: caveats, secrets, or release constraints.
## Repo-Specific Guidance
- Commands must match `.agents/rules/development-commands.md`.
- Convex docs must mention `convex/_generated/ai/guidelines.md` when edits touch `convex/`.
- Web docs should refer to `web-app/`.
- Mobile docs should refer to `mobile-app/`.
- Cross-surface configuration docs should refer to `site-config.ts`.
- Store-release docs should preserve the existing `asc`, `gpc`, and screenshot workflow conventions.
## Avoid
- Legacy public-docs-tree references from the web-only SaaS repo.
- MDX-only components or imports.
- Public `/docs/[slug]` route checks.
- NowStack SaaS org-route examples that do not exist in this repo.
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: 470k | 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: 197k | 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: 197k | 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: 197k | Updated | Claude CodeCodex | Verified | Install |