# Nodie Wiki

> Maintain durable markdown knowledge. Use when asked to remember, save, preserve, review/update repo architecture, document code, study source code, research a topic, organize notes, or build a long-lived wiki.

- Skill: `nodie-ai/nodie-wiki` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx skillmds@latest add nodie-ai/nodie-wiki`
- Raw SKILL.md: https://api.skillmd.com/api/skills/nodie-ai/nodie-wiki/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: Nodie-AI (https://skillmd.com/u/nodie-ai)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/nodie-ai/nodie-wiki

---


# /nodie-wiki

Maintain `.nodie/` with the minimum edit that keeps code, facts, and docs consistent.

## Layout

```
.nodie/
  MEMORY.md                    # one-sentence durable takeaways
  CLAUDE.md                    # tell Claude to read the relevant .nodie README first
  AGENTS.md                    # tell Codex to read the relevant .nodie README first
  repo/                        # current code repo architecture/module docs
    README.md                  # architecture map, flows, module boundaries
    <module>.md
    pitfalls/                  # historical bugs/regressions, one file per ID
      <PITFALL-ID>.md
    <area>/                    # only for large module groups
      README.md
      <module>.md
  ref/                         # third-party service/framework/library references
    README.md
    <dependency-or-tool>.md
  wiki/                        # user/domain knowledge not owned by the code repo
    README.md
    <topic>.md
    <topic>/
      <topic>.md
      01-<supporting-file>.md
```

## Ownership

- `.nodie/repo`: repo architecture, modules, data flows, public interfaces, implementation caveats, and module regression contracts.
- `.nodie/repo/pitfalls`: detailed records for historical bugs, regressions, edge cases, and sharp implementation failures.
- `.nodie/ref`: dependency/API/framework/tool facts.
- `.nodie/wiki`: user/domain knowledge, research, daily notes, records.
- `.nodie/MEMORY.md`: the only memory file.
- `.nodie/CLAUDE.md` and `.nodie/AGENTS.md`: root-level pointers only.

If ownership is unclear, ask which `.nodie/wiki/<category>` should own it before creating a new category.

## Structure Rules

- Put module docs directly under `.nodie/repo` by default.
- Keep pitfall detail pages under `.nodie/repo/pitfalls/<PITFALL-ID>.md`; do not scatter historical bug writeups in handoff files as the only source of truth.
- Create `.nodie/repo/<area>/README.md` only when a related group exceeds 5 module docs or needs its own architecture/data-flow map.
- `.nodie/wiki` is flat by default: simple topics use `<topic>.md`; larger topics use `<topic>/<topic>.md` plus numbered supporting files.
- Use date prefixes only when chronology matters: `YYYY-MM-DD-<topic>.md` or `YYYY-MM-DD-<topic>/YYYY-MM-DD-<topic>.md`.
- If existing docs use old names/locations, restructure them into this layout and preserve content.

## Maintenance Rules

- Read the nearest `README.md`, target page/section, and linked relevant sections before editing; create the README first if it does not exist.
- Update canonical pages in place; merge stale or duplicate content into the canonical location.
- Keep nearby `README.md` navigation accurate when files or sections move.
- Treat source code as authoritative over docs unless the user says otherwise.
- Before editing a code module, read that module doc and its `Regression Contract` / `Known Pitfalls` sections; if the section is missing, add it when you discover a historical edge case.
- When a bug, regression, or sharp edge is fixed, update the owning module doc with a one-line pitfall row and create or update the matching `.nodie/repo/pitfalls/<PITFALL-ID>.md` detail page.
- Handoffs, issue comments, chat logs, and run summaries are evidence, not durable ground truth. Promote lasting lessons into module docs and pitfall pages.
- During initial repo documentation, cover the core architecture and the 3-5 modules needed for current work; a module is a stable boundary such as a protocol, schema/model, runtime, renderer, service, or adapter, not every utility file.
- For a large initial repo-doc pass, create only the root pointers, root README, memory file, and the 3-5 module files directly needed by the current task. Stop after that coherent batch.
- Preserve unknown legacy directories until the user asks for cleanup. Document their status in the nearest `README.md` instead of moving or deleting them.
- Before creating `.nodie/ref` docs, check whether the repo already has `docs/ref`, `reference`, or equivalent dependency docs; link to existing references instead of duplicating them when they are current.

## Content Rules

- `.nodie/repo` docs include owned paths, core data structures, public interfaces, main flows, dependencies, and caveats.
- Every `.nodie/repo` module doc includes `Regression Contract` and `Known Pitfalls`. Each pitfall row is one sentence, links to one detail page by ID, and states the affected surface and invariant.
- Every `.nodie/repo/pitfalls/<PITFALL-ID>.md` page records symptom, affected module, root cause, fix pattern, regression checks, and backlinks to the owning module doc.
- `.nodie/ref` docs emphasize exact interface facts: paths, methods, request/response shapes, config keys, commands, pitfalls, version constraints, source links.
- `.nodie/wiki` synthesis topics distill facts; record-style topics preserve user statements with minimal interpretation.

## Links

- Add stable anchors to important headings: `## Core Data Flows \[#core-data-flows]`.
- Prefer section links for specific facts: `[Core Data Flows](architecture.md#core-data-flows)`.
- Use bidirectional links for pitfalls: module pitfall row -> `pitfalls/<PITFALL-ID>.md`; pitfall detail -> owning module doc section and any source handoff/spec/issue.
- When moving or renaming files/sections, update inbound links found with `rg`.
- Navigation may include future placeholder links when a large doc set cannot be completed in one turn, but every placeholder must use exactly this visible style: `TODO: [Title](path.md)`.
- Do not describe placeholder links as current source of truth or required reading.

## Output Contract

When initializing `.nodie/` for a code repo, finish this minimum coherent set before doing anything optional:

1. `.nodie/AGENTS.md` and `.nodie/CLAUDE.md`: root pointers to current docs; placeholder links are allowed only with the exact `TODO: [Title](path.md)` style.
2. `.nodie/MEMORY.md`: one-sentence durable facts.
3. `.nodie/repo/README.md`: architecture map, core flows, module index, legacy directory notes if any.
4. Three to five module docs under `.nodie/repo/` that match the current task, each with a `Regression Contract` and `Known Pitfalls` section.
5. Optional `.nodie/ref/README.md` or `.nodie/wiki/<topic>.md` only when the task requires them.

When initial docs reveal prior handoffs/spec rows about a module bug, create the pitfall index row and detail page in the same pass. If time is limited, create the pitfall row with a `TODO:` detail link using the required placeholder style.

Before finishing, verify local markdown links you introduced. Existing docs should resolve to real files; future docs may be unresolved only when written with the exact `TODO: [Title](path.md)` style.

## Templates

Load only for new pages or major rewrites:

- `references/codebase-template.md` for `.nodie/repo` docs and external codebase studies.
- `references/ref-template.md` for `.nodie/ref` dependency/tool/API references.
- `references/knowledge-template.md` for `.nodie/wiki` topics and user-defined knowledge categories.

Reference paths are relative to this skill directory.

