mb-garden

SKILL.md

mb-garden — Memory Bank maintenance (doc gardening)

  • What it does: checks Memory Bank structure, fixes hygiene issues, and keeps docs navigable.
  • Use it when: .memory-bank/ exists and you want to reduce drift, stale docs, or broken routing.
  • Input: an existing .memory-bank/.
  • Output: a cleaner Memory Bank, resolved lint issues, and optional CI support for ongoing maintenance.

Goal

Keep .memory-bank/ accurate, navigable, and cheap-to-prime.

Preconditions

  • .memory-bank/ exists.

Process

1) Run a mechanical lint (deterministic)

If the repo doesn’t have a linter yet:

  1. Create scripts/mb-lint.mjs using assets/mb-lint.mjs.
  2. Make it executable (optional).
  3. Add a package script (optional): "mb:lint": "node scripts/mb-lint.mjs".

Then run:

node scripts/mb-lint.mjs

Fix all ERROR findings:

  • missing YAML frontmatter (description + status)
  • broken links
  • missing folder index.md

2) Refactor for ergonomics

  • Split docs > ~700 lines into atomic docs + router index.
  • Ensure duo docs exist for key concepts (architecture WHAT/WHY + guide HOW).
  • Replace copy-pasted code/config with links to source.

3) Archive stale or superseded docs

  • Move outdated docs to .memory-bank/archive/.
  • Leave a short tombstone stub in the original location with a link to the archive.

4) Optional: add CI gate

If the repo uses GitHub Actions:

  • Create .github/workflows/memory-bank-lint.yml from assets/memory-bank-lint.yml.

5) Produce a short report

Write a summary (what changed + what remains) to:

  • .tasks/TASK-MB-GARDEN/TASK-MB-GARDEN-S-01-final-report-docs-01.md

6) Weekly maintenance checklist

Run this checklist weekly (or every 5–10 meaningful changes):

  1. Frontmatter audit: every .memory-bank/**/*.md has description + status.
  2. Stale docs: scan for docs not updated in >2 weeks — archive or refresh.
  3. Duo docs check: every architecture/<X>.md has a matching guides/<X>.md (and vice versa).
  4. RTM sync: requirements.md RTM matches actual feature/test status.
  5. Backlog hygiene: completed tasks marked done, no orphaned tasks without feature link.
  6. Changelog: .memory-bank/changelog.md has entries for recent changes.
  7. Index links: all links in index.md and router-indexes resolve correctly.
  8. Archive tombstones: every doc in archive/ has a tombstone stub at original location.

Definition of done

  • node scripts/mb-lint.mjs passes (0 errors).
  • Index navigation is coherent.
  • No obvious duplication or stale docs without archive.
  • Weekly checklist items are addressed.
Weekly Installs
14
GitHub Stars
32
First Seen
11 days ago
Installed on
kimi-cli14
gemini-cli14
amp14
cline14
github-copilot14
codex14