@sandrinio/vdoc 3.0.0

package/skills/continue/vdoc.md

@@ -0,0 +1,177 @@
+---
+name: vdoc
+description: "Generate and maintain feature-centric product documentation. Handles init (explore codebase, plan docs, generate), audit (detect stale/missing/dead docs, patch), and query (route questions via semantic manifest)."
+alwaysApply: false
+globs:
+---
+
+# vdoc — Documentation Generator
+
+You generate and maintain feature-centric documentation for codebases. You have three modes: **init**, **audit**, and **query**.
+
+All documentation lives in `vdocs/` at the project root. The manifest at `vdocs/_manifest.json` is the semantic index you read first.
+
+---
+
+## Mode 1: Init
+
+**Trigger:** User says "document this project" or similar.
+
+### Step 1 — Explore
+
+Read the codebase thoroughly. Identify:
+
+- **Tech stack**: languages, frameworks, databases, ORMs
+- **Features**: authentication, API, payments, notifications, search, etc.
+- **Architecture**: monolith vs microservices, frontend/backend split, key patterns
+- **Integrations**: third-party services (Stripe, AWS, Redis, etc.)
+- **Entry points**: where requests come in, how they flow through the system
+
+Do not skim. Read key files — entry points, config, routes, schemas, middleware.
+
+### Step 2 — Plan
+
+Create `vdocs/_DOCUMENTATION_PLAN.md` listing each proposed doc with a one-line description. Present to user. Suggest merges, additions, or removals. Wait for approval.
+
+### Step 3 — Generate
+
+For each approved doc, read ALL relevant source files and generate using this template:
+
+```markdown
+# {Feature Title}
+
+> {One-line description}
+
+---
+
+## Overview
+{What it does, why it exists, how it fits in the system.}
+
+---
+
+## How It Works
+{Core logic and flow.}
+{Mermaid diagram(s) — max 7-9 nodes per diagram, split if larger.}
+
+---
+
+## Data Model
+{Entities this feature owns. Mermaid ER diagram or table.}
+
+---
+
+## Key Files
+| File | Purpose |
+|------|---------|
+| `src/path/file.ts` | What this file does |
+
+---
+
+## Dependencies & Integrations
+{External services, internal features, packages this relies on.}
+
+---
+
+## Configuration
+| Variable | Purpose | Required |
+|----------|---------|----------|
+| `ENV_VAR` | What it controls | Yes/No |
+
+---
+
+## Error Handling
+{Failure modes, what the user sees, retry logic. Mermaid diagram if non-trivial.}
+
+---
+
+## Constraints & Decisions
+{Why it's built this way. What you CANNOT change without breaking things.}
+
+---
+
+## Related Features
+{Cross-references to other docs by filename. Blast radius notes.}
+
+---
+
+*Generated by vdoc v3.0.0 • Last updated: {timestamp}*
+```
+
+**Writing rules:**
+
+- **Mermaid diagrams are mandatory** in "How It Works". Max 7-9 nodes — split larger flows.
+- **Data Model** must show real entities from the code, not placeholders.
+- **Constraints & Decisions** is the most valuable section. Dig for non-obvious choices. If unclear, write: `Reason: unknown — verify with team`.
+- **Related Features** must reference other doc filenames and explain coupling.
+- **Configuration** must list actual env vars from the code.
+- **Error Handling** — trace what happens when things fail.
+
+### Step 4 — Manifest
+
+Create `vdocs/_manifest.json`:
+
+```json
+{
+  "project": "<project-name>",
+  "vdoc_version": "3.0.0",
+  "created_at": "<ISO-8601>",
+  "last_updated": "<ISO-8601>",
+  "last_commit": "<short-sha>",
+  "documentation": [
+    {
+      "filepath": "FEATURE_NAME_DOC.md",
+      "title": "Human-Readable Title",
+      "version": "1.0.0",
+      "description": "Rich semantic description with technology names, patterns, concepts. Detailed enough for AI to route questions to this doc.",
+      "tags": ["keyword-tag"]
+    }
+  ]
+}
+```
+
+### Step 5 — Self-Review
+
+Verify: every doc has mermaid diagrams, at least 2 constraints, real file paths, actual env vars, cross-references. Manifest descriptions are detailed for semantic routing. No hallucinated content.
+
+---
+
+## Mode 2: Audit
+
+**Trigger:** User says "audit docs" or similar.
+
+1. **Read manifest** — load `vdocs/_manifest.json`
+2. **Detect stale** — `git diff` or `git log --name-only --since="<last_updated>"` to find changed source files. Cross-reference with each doc's "Key Files" section.
+3. **Detect gaps** — scan codebase for significant source files not covered by any doc (new routes, services, models, config).
+4. **Detect dead docs** — check each doc's "Key Files" against filesystem. Flag docs referencing deleted files.
+5. **Check cross-refs** — verify "Related Features" links still exist and coupling is accurate.
+6. **Report** — present stale, gaps, dead, cross-ref issues, and current docs. Wait for user direction.
+7. **Patch** — update stale docs, generate new docs for gaps, flag dead docs, fix cross-refs. Update manifest.
+
+---
+
+## Mode 3: Query
+
+**Trigger:** User asks any question about the codebase or documentation.
+
+1. Read `vdocs/_manifest.json`
+2. Match question against `description` and `tags` fields
+3. Read matching doc(s)
+4. Answer from documented knowledge
+5. If no match, suggest running an audit
+
+---
+
+## Naming Convention
+
+Files: `FEATURE_NAME_DOC.md` — uppercase, feature-named, `_DOC` suffix.
+
+---
+
+## Rules
+
+1. **Feature-centric, not file-centric.** One doc per logical feature, not per source file.
+2. **Mermaid over prose.** Diagram flows. Max 7-9 nodes per diagram.
+3. **Constraints are gold.** Always fill "Constraints & Decisions".
+4. **Rich manifest descriptions.** Pack with specific terms for semantic routing.
+5. **No hallucination.** Only document what exists in code.
+6. **Plan first, always.** Never generate without user-approved plan.

package/skills/cursor/vdoc-command.md

@@ -0,0 +1,33 @@
+# /vdoc — Documentation Generator
+
+Run documentation workflows for this project. The detailed instructions are in `.cursor/rules/vdoc.mdc`.
+
+## Usage
+
+- `/vdoc init` — Explore codebase, create documentation plan, generate docs
+- `/vdoc audit` — Detect stale, missing, and dead docs, then patch
+- `/vdoc` (no args) — Show available commands
+
+## Execution
+
+$ARGUMENTS
+
+**If the argument is `init` or empty with no existing `vdocs/` folder:**
+
+1. **Explore** — Read the codebase thoroughly: tech stack, features, architecture, integrations, entry points. Read actual files, don't skim.
+2. **Plan** — Create `vdocs/_DOCUMENTATION_PLAN.md` listing each proposed doc. Present to user. Wait for approval.
+3. **Generate** — For each approved doc, read ALL relevant source files. Write `vdocs/FEATURE_NAME_DOC.md` following the template and writing rules in `.cursor/rules/vdoc.mdc`.
+4. **Manifest** — Create `vdocs/_manifest.json` with rich semantic descriptions per doc.
+5. **Self-review** — Verify: mermaid diagrams, real file paths, 2+ constraints per doc, cross-references, no hallucinated content.
+
+**If the argument is `audit` or empty with existing `vdocs/` folder:**
+
+1. **Read** `vdocs/_manifest.json`
+2. **Stale** — git diff since `last_updated`, cross-ref with each doc's "Key Files" section
+3. **Gaps** — find undocumented features (new routes, services, models)
+4. **Dead** — docs referencing deleted source files
+5. **Cross-refs** — verify Related Features links still valid
+6. **Report** — present findings, wait for user direction
+7. **Patch** — update stale docs, generate new ones for gaps, fix cross-refs, update manifest
+
+**If no arguments and `vdocs/` exists, treat as audit.**

package/skills/cursor/vdoc.mdc

@@ -0,0 +1,176 @@
+---
+description: "Generate and maintain feature-centric product documentation. Handles init (explore codebase, plan docs, generate), audit (detect stale/missing/dead docs, patch), and query (route questions via semantic manifest). Activates when user asks about documentation, says 'document this project', 'audit docs', or asks questions about codebase features."
+globs:
+alwaysApply: false
+---
+
+# vdoc — Documentation Generator
+
+You generate and maintain feature-centric documentation for codebases. You have three modes: **init**, **audit**, and **query**.
+
+All documentation lives in `vdocs/` at the project root. The manifest at `vdocs/_manifest.json` is the semantic index you read first.
+
+---
+
+## Mode 1: Init
+
+**Trigger:** User says "document this project" or similar.
+
+### Step 1 — Explore
+
+Read the codebase thoroughly. Identify:
+
+- **Tech stack**: languages, frameworks, databases, ORMs
+- **Features**: authentication, API, payments, notifications, search, etc.
+- **Architecture**: monolith vs microservices, frontend/backend split, key patterns
+- **Integrations**: third-party services (Stripe, AWS, Redis, etc.)
+- **Entry points**: where requests come in, how they flow through the system
+
+Do not skim. Read key files — entry points, config, routes, schemas, middleware.
+
+### Step 2 — Plan
+
+Create `vdocs/_DOCUMENTATION_PLAN.md` listing each proposed doc with a one-line description. Present to user. Suggest merges, additions, or removals. Wait for approval.
+
+### Step 3 — Generate
+
+For each approved doc, read ALL relevant source files and generate using this template:
+
+```markdown
+# {Feature Title}
+
+> {One-line description}
+
+---
+
+## Overview
+{What it does, why it exists, how it fits in the system.}
+
+---
+
+## How It Works
+{Core logic and flow.}
+{Mermaid diagram(s) — max 7-9 nodes per diagram, split if larger.}
+
+---
+
+## Data Model
+{Entities this feature owns. Mermaid ER diagram or table.}
+
+---
+
+## Key Files
+| File | Purpose |
+|------|---------|
+| `src/path/file.ts` | What this file does |
+
+---
+
+## Dependencies & Integrations
+{External services, internal features, packages this relies on.}
+
+---
+
+## Configuration
+| Variable | Purpose | Required |
+|----------|---------|----------|
+| `ENV_VAR` | What it controls | Yes/No |
+
+---
+
+## Error Handling
+{Failure modes, what the user sees, retry logic. Mermaid diagram if non-trivial.}
+
+---
+
+## Constraints & Decisions
+{Why it's built this way. What you CANNOT change without breaking things.}
+
+---
+
+## Related Features
+{Cross-references to other docs by filename. Blast radius notes.}
+
+---
+
+*Generated by vdoc v3.0.0 • Last updated: {timestamp}*
+```
+
+**Writing rules:**
+
+- **Mermaid diagrams are mandatory** in "How It Works". Max 7-9 nodes — split larger flows into multiple diagrams.
+- **Data Model** must show real entities from the code, not placeholders.
+- **Constraints & Decisions** is the most valuable section. Dig for non-obvious choices. If the reason is unclear, write: `Reason: unknown — verify with team`.
+- **Related Features** must reference other doc filenames and explain the coupling.
+- **Configuration** must list actual env vars from the code.
+- **Error Handling** — trace what happens when things fail.
+
+### Step 4 — Manifest
+
+Create `vdocs/_manifest.json`:
+
+```json
+{
+  "project": "<project-name>",
+  "vdoc_version": "3.0.0",
+  "created_at": "<ISO-8601>",
+  "last_updated": "<ISO-8601>",
+  "last_commit": "<short-sha>",
+  "documentation": [
+    {
+      "filepath": "FEATURE_NAME_DOC.md",
+      "title": "Human-Readable Title",
+      "version": "1.0.0",
+      "description": "Rich semantic description with technology names, patterns, concepts. Detailed enough for AI to route questions to this doc.",
+      "tags": ["keyword-tag"]
+    }
+  ]
+}
+```
+
+### Step 5 — Self-Review
+
+Verify: every doc has mermaid diagrams, at least 2 constraints, real file paths, actual env vars, cross-references. Manifest descriptions are detailed enough for semantic routing. No hallucinated content.
+
+---
+
+## Mode 2: Audit
+
+**Trigger:** User says "audit docs" or similar.
+
+1. **Read manifest** — load `vdocs/_manifest.json`
+2. **Detect stale** — `git diff` or `git log --name-only --since="<last_updated>"` to find changed source files. Cross-reference with each doc's "Key Files" section.
+3. **Detect gaps** — scan codebase for significant features not covered by any doc (new routes, services, models, config).
+4. **Detect dead docs** — check each doc's "Key Files" against filesystem. Flag docs referencing deleted files.
+5. **Check cross-refs** — verify "Related Features" links still exist and coupling descriptions are accurate.
+6. **Report** — present stale docs, coverage gaps, dead docs, cross-ref issues, and current docs. Wait for user direction.
+7. **Patch** — update stale docs (re-read source, update affected sections). Generate new docs for gaps. Flag dead docs for removal. Fix cross-refs. Update manifest.
+
+---
+
+## Mode 3: Query
+
+**Trigger:** User asks any question about the codebase or documentation.
+
+1. Read `vdocs/_manifest.json`
+2. Match question against `description` and `tags` fields
+3. Read matching doc(s)
+4. Answer from documented knowledge
+5. If no match, say so and suggest running an audit
+
+---
+
+## Naming Convention
+
+Files: `FEATURE_NAME_DOC.md` — uppercase, feature-named, `_DOC` suffix.
+
+---
+
+## Rules
+
+1. **Feature-centric, not file-centric.** One doc per logical feature, not per source file.
+2. **Mermaid over prose.** Diagram flows. Max 7-9 nodes per diagram.
+3. **Constraints are gold.** Always fill "Constraints & Decisions". It prevents breaking changes.
+4. **Rich manifest descriptions.** Pack with specific terms for semantic routing.
+5. **No hallucination.** Only document what exists in code.
+6. **Plan first, always.** Never generate without user-approved plan. Report before patching.

package/skills/gemini/GEMINI.md

@@ -0,0 +1,174 @@
+<!-- vdoc:start -->
+
+# vdoc — Documentation Generator
+
+You generate and maintain feature-centric documentation for codebases. You have three modes: **init**, **audit**, and **query**.
+
+All documentation lives in `vdocs/` at the project root. The manifest at `vdocs/_manifest.json` is the semantic index you read first.
+
+---
+
+## Mode 1: Init
+
+**Trigger:** User says "document this project" or similar.
+
+### Step 1 — Explore
+
+Read the codebase thoroughly. Identify:
+
+- **Tech stack**: languages, frameworks, databases, ORMs
+- **Features**: authentication, API, payments, notifications, search, etc.
+- **Architecture**: monolith vs microservices, frontend/backend split, key patterns
+- **Integrations**: third-party services (Stripe, AWS, Redis, etc.)
+- **Entry points**: where requests come in, how they flow through the system
+
+Do not skim. Read key files — entry points, config, routes, schemas, middleware.
+
+### Step 2 — Plan
+
+Create `vdocs/_DOCUMENTATION_PLAN.md` listing each proposed doc with a one-line description. Present to user. Suggest merges, additions, or removals. Wait for approval.
+
+### Step 3 — Generate
+
+For each approved doc, read ALL relevant source files and generate using this template:
+
+```markdown
+# {Feature Title}
+
+> {One-line description}
+
+---
+
+## Overview
+{What it does, why it exists, how it fits in the system.}
+
+---
+
+## How It Works
+{Core logic and flow.}
+{Mermaid diagram(s) — max 7-9 nodes per diagram, split if larger.}
+
+---
+
+## Data Model
+{Entities this feature owns. Mermaid ER diagram or table.}
+
+---
+
+## Key Files
+| File | Purpose |
+|------|---------|
+| `src/path/file.ts` | What this file does |
+
+---
+
+## Dependencies & Integrations
+{External services, internal features, packages this relies on.}
+
+---
+
+## Configuration
+| Variable | Purpose | Required |
+|----------|---------|----------|
+| `ENV_VAR` | What it controls | Yes/No |
+
+---
+
+## Error Handling
+{Failure modes, what the user sees, retry logic. Mermaid diagram if non-trivial.}
+
+---
+
+## Constraints & Decisions
+{Why it's built this way. What you CANNOT change without breaking things.}
+
+---
+
+## Related Features
+{Cross-references to other docs by filename. Blast radius notes.}
+
+---
+
+*Generated by vdoc v3.0.0 • Last updated: {timestamp}*
+```
+
+**Writing rules:**
+
+- **Mermaid diagrams are mandatory** in "How It Works". Max 7-9 nodes — split larger flows.
+- **Data Model** must show real entities from the code, not placeholders.
+- **Constraints & Decisions** is the most valuable section. Dig for non-obvious choices. If unclear, write: `Reason: unknown — verify with team`.
+- **Related Features** must reference other doc filenames and explain coupling.
+- **Configuration** must list actual env vars from the code.
+- **Error Handling** — trace what happens when things fail.
+
+### Step 4 — Manifest
+
+Create `vdocs/_manifest.json`:
+
+```json
+{
+  "project": "<project-name>",
+  "vdoc_version": "3.0.0",
+  "created_at": "<ISO-8601>",
+  "last_updated": "<ISO-8601>",
+  "last_commit": "<short-sha>",
+  "documentation": [
+    {
+      "filepath": "FEATURE_NAME_DOC.md",
+      "title": "Human-Readable Title",
+      "version": "1.0.0",
+      "description": "Rich semantic description with technology names, patterns, concepts. Detailed enough for AI to route questions to this doc.",
+      "tags": ["keyword-tag"]
+    }
+  ]
+}
+```
+
+### Step 5 — Self-Review
+
+Verify: every doc has mermaid diagrams, at least 2 constraints, real file paths, actual env vars, cross-references. Manifest descriptions are detailed for semantic routing. No hallucinated content.
+
+---
+
+## Mode 2: Audit
+
+**Trigger:** User says "audit docs" or similar.
+
+1. **Read manifest** — load `vdocs/_manifest.json`
+2. **Detect stale** — `git diff` or `git log --name-only --since="<last_updated>"` to find changed source files. Cross-reference with each doc's "Key Files" section.
+3. **Detect gaps** — scan codebase for significant source files not covered by any doc (new routes, services, models, config).
+4. **Detect dead docs** — check each doc's "Key Files" against filesystem. Flag docs referencing deleted files.
+5. **Check cross-refs** — verify "Related Features" links still exist and coupling is accurate.
+6. **Report** — present stale, gaps, dead, cross-ref issues, and current docs. Wait for user direction.
+7. **Patch** — update stale docs, generate new docs for gaps, flag dead docs, fix cross-refs. Update manifest.
+
+---
+
+## Mode 3: Query
+
+**Trigger:** User asks any question about the codebase or documentation.
+
+1. Read `vdocs/_manifest.json`
+2. Match question against `description` and `tags` fields
+3. Read matching doc(s)
+4. Answer from documented knowledge
+5. If no match, suggest running an audit
+
+---
+
+## Naming Convention
+
+Files: `FEATURE_NAME_DOC.md` — uppercase, feature-named, `_DOC` suffix.
+
+---
+
+## Rules
+
+1. **Feature-centric, not file-centric.** One doc per logical feature, not per source file.
+2. **Mermaid over prose.** Diagram flows. Max 7-9 nodes per diagram.
+3. **Constraints are gold.** Always fill "Constraints & Decisions".
+4. **Rich manifest descriptions.** Pack with specific terms for semantic routing.
+5. **No hallucination.** Only document what exists in code.
+6. **Plan first, always.** Never generate without user-approved plan.
+
+<!-- vdoc:end -->

package/skills/gemini/vdoc.toml

@@ -0,0 +1,27 @@
+description = "Generate and maintain feature-centric product documentation. Use: /vdoc init or /vdoc audit"
+
+prompt = """
+# vdoc — Documentation Generator
+
+Run documentation workflows for this project. Full instructions are in GEMINI.md under the vdoc section.
+
+**User request:** {{args}}
+
+## If "init" or no vdocs/ folder exists:
+
+1. **Explore** — Read the codebase: tech stack, features, architecture, integrations, entry points. Read actual files.
+2. **Plan** — Create `vdocs/_DOCUMENTATION_PLAN.md` listing proposed docs. Present to user. Wait for approval.
+3. **Generate** — For each doc, read ALL relevant source files. Write `vdocs/FEATURE_NAME_DOC.md` following the template in GEMINI.md.
+4. **Manifest** — Create `vdocs/_manifest.json` with rich semantic descriptions.
+5. **Verify** — Every doc has mermaid diagrams, real paths, 2+ constraints, cross-references.
+
+## If "audit" or vdocs/ already exists:
+
+1. Read `vdocs/_manifest.json`
+2. **Stale** — git diff since last_updated, cross-ref with each doc's Key Files section
+3. **Gaps** — undocumented features (new routes, services, models)
+4. **Dead** — docs referencing deleted files
+5. **Cross-refs** — verify Related Features links
+6. **Report** — present findings, wait for user direction
+7. **Patch** — update stale, generate gaps, fix cross-refs, update manifest
+"""