Doc Add Knowledge

Table of Contents

When to use this skill

Capturing durable, cross-cutting rationale as a knowledge document — concepts, conventions, design systems; not how-to steps (that is a recipe).

How to use this skill

  1. Scaffold:

    ./projects/ores.compass/compass.sh add knowledge --slug <slug> --parent-dir doc/knowledge/<topic> --title "<title>" --description "<desc>" --tags "<tags>"
    
  1. Fill * Summary (load-bearing facts) and * Detail (navigable, not exhaustive); link related docs with [[id:...]].
  2. Wire the topic index page so the doc is reachable, and commit.

Recipes

Reference

Emacs 29.1 (Org mode 9.6.6)