doc-wiki

A set of rules and commands for managing a documentation wiki in a codebase. A documentation wiki is an organized collection of linked pages about a project's systems and processes.

In plain words
What is it for?
Use it to ingest sources, generate or edit pages, search and synthesize documentation, check wiki health, and view usage statistics.
Why use it?
It defines how to initialize, fill, search, edit, check, and measure the wiki so documentation work follows a consistent process.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/narailabs/doc-wiki/doc-wiki
Clone the repo
git clone --depth 1 https://github.com/narailabs/doc-wiki

Made for: Cursor.

Per session 1,399 This file is loaded in full into every session.
When invoked 1,399 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01399 $0.01399
Opus 5 $0.00700 $0.00700
Sonnet 5 $0.00280 $0.00280
Haiku 4.5 $0.00140 $0.00140

Measured 2d ago against content hash b7b9d1b73b79, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

doc-wiki scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/doc-wiki.mdc · 91 lines

How it starts

The opening of the file, as written. The whole thing — 91 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Wiki Skill

This project has a documentation wiki skill. Before searching the codebase with grep, find, or glob, check if the wiki has the answer by running wiki-query first.

Commands

  • /doc-wiki:init -- Bootstrap wiki scaffold (includes ecosystem onboarding in Phase 3): node skills/doc-wiki/scripts/init_wiki.js --path <wiki-root> --domain "<domain>" --name "<name>"
  • /doc-wiki:ingest -- Fetch, extract, compile sources into wiki pages; use --refresh to re-fetch previously ingested sources
  • /doc-wiki:query -- Two modes: synthesis (<question>) for summary-first search with --promote <file> to save answer as a page, or path mode (--from <a> --to <b>) for shortest-path traversal via node skills/doc-wiki/scripts/graph_ops.js path --edges <wiki-root>/graph/edges.jsonl
  • /doc-wiki:lint -- Health check: node skills/doc-wiki/scripts/lint_checks.js --wiki-root <wiki-root>
  • /doc-wiki:edit -- Targeted page edit with diff preview
  • /doc-wiki:stats -- Token efficiency: node skills/doc-wiki/scripts/event_logger.js stats --wiki-root <wiki-root> --since 7d

Script Paths

All TypeScript scripts live at: skills/doc-wiki/scripts/ and compile to .js siblings via npm run build.

Script Purpose
init_wiki.ts Bootstrap wiki scaffold
parse_config.ts Read/write wiki.config.yaml
cache_manager.ts Content-hash cache for dedup
extract_binary.ts Binary file extraction
lint_checks.ts Structural lint checks
quality_score.ts Page quality scoring (0.0-1.0)
graph_ops.ts Graph traversal and path queries
event_logger.ts Operation logging and stats
mermaid_lint.ts Mermaid diagram validation
daily_summary.ts Daily summary generation

Agent Paths

Sub-agents at agents/. External-source fetching is handled by the connectors bundled inside narai-primitives and dispatched through its gather() planner — no per-service subagents in doc-wiki.

  • wiki-orm-agent -- ORM profile detection
  • wiki-mermaid-agent -- Mermaid diagram generation
  • wiki-claude-md-agent -- CLAUDE.md maintenance
  • wiki-readme-agent -- Sync repo-root README.md quickstart block against wiki/getting-started.md; dispatched alongside wiki-claude-md-agent in atlas Phase 8

Read the full file on GitHub · 91 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 91 lines · 1,399 tokens per session scan A b7b9d1b73b79

Subscribe to this mod's changes

doc-wiki is a cursor rule published in the GitHub repository narailabs/doc-wiki (13 stars, last pushed 2d ago), licensed Apache-2.0. It adds 1,399 tokens to every session, about $0.0070 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.