Skip to content

Creating a Knowledge Bundle

Jump to bottom
Chris Sweet edited this page Jul 14, 2026 · 2 revisions

type: reference up: "Knowledge-Bundles-Overview" related:

Creating a Knowledge Bundle

End-to-end how-to for building a knowledge bundle from the llm-wiki template and publishing it so others can consume it. A bundle is a shareable, LLM-authored wiki on a topic (see Knowledge-Bundles-Overview); this page is the "put it all together" path that ties the other pages into one workflow. Each step links to the page with the detail.

0. Decide it is a bundle

A bundle is a wiki you intend to share and have others ask, so its reason to exist is consumption, not just your own working memory. If that is not true, you may just want a normal project wiki. See When-to-Use-When-Not for the call, and Bundle-Pages-and-Supplementary-Data for the practices that apply specifically to bundle-primary repos in a github.io environment.

1. Instantiate from the template

Create the project from crcresearch/llm-wiki-memory-template. Enable the federation feature at instantiation if you already know you will publish:

./scripts/instantiate.sh "My Bundle Name" --agent=claude-code --features=agent-comms

This scaffolds the wiki sub-repo (Home, index, log, SCHEMA, Edge-Types), a generated CLAUDE.md, the Claude Code overlay, and the agent-comms feature. If you skip --features now, add it later with ./scripts/enable-feature.sh agent-comms. Full detail: Installation-and-Setup.

2. Author the wiki (this is the bulk of the work)

Fill the bundle with knowledge using the three operations, letting the LLM do the writing:

  • Ingest sources with /wiki-source (papers, articles, docs) and file syntheses and results as you go. See Everyday-Operations.
  • Aim past facts: capture the author's judgment (synthesis and decision pages, criticizes:/supports: edges) and experience (dated logs, honest failure notes). This is what makes a bundle a mentor rather than a reference work. See Template-Philosophy and the authoring checklist in Best-Practices.
  • Keep it text-first. Everything load-bearing must be Markdown/frontmatter, because the ask path reads text, not images. Small captioned images are fine; never make an image load-bearing. See Bundle-Pages-and-Supplementary-Data.
  • Follow the conventions (Wiki-Structure-and-Conventions): valid frontmatter (type:, up:), bidirectional links, index and log kept current.

3. Keep it healthy and honest

  • Run /wiki-lint periodically (orphans, dead links, stale claims). See Everyday-Operations.
  • The Verification Gate runs before every commit (corpus-tagged numbers, resolved links, back-references, honest reporting). Do not file projections as facts. See Best-Practices.
  • Let the LLM commit (local commits are reversible); one commit per log entry.

4. Build the knowledge graph (optional)

If you want topology queries over the bundle, rebuild the graph after edits:

./scripts/kg/build-graph.sh

This is opt-in; the bundle is fully usable without it. See Knowledge-Graph.

5. Publish the bundle

The wiki is a separate git sub-repo with its own remote. Push it only when you intend to publish:

git -C wiki/<repo>.wiki push origin master

For a shared bundle with multiple writers, push via the write protocol (wiki_push) rather than plain git push. See Team-Workflow.

6. Make it discoverable (federation)

So others can find and ask your bundle, publish an agent Card into the federation index:

bash scripts/agent-comms/enroll.sh

enroll.sh writes wiki/<repo>.wiki/Card_<repo>.md from interactive prompts and, if your repo is in a trusted owner/org, the daily rebuild picks it up; otherwise it offers to add the nd-llm-wiki topic (trusted-owner allowlist applies). Then commit and push the Card to the wiki. See Team-Workflow and Extending-the-Template.

Gotcha (learned the hard way): quote colons in the Card. The federation index builder parses the Card's YAML frontmatter. If a description: (or any value) contains a colon and is left unquoted, the parse fails with mapping values are not allowed here and the Card is silently skipped. Quote such values: description: "Knowledge bundle: what it is and how to use it."

7. Add a supplementary site (optional, bundle-primary repos in a github.io environment)

If your repo is primarily a bundle and lives in a github.io environment, publish a GitHub Pages site from the main repo (main:/docs) for datasets, figures, and demos, keep the wiki text-first, and link the Pages site from the wiki Home page (that is where the Card's home_url resolves). Mark the link pending until the site is actually live. See Bundle-Pages-and-Supplementary-Data for the full decision and the current federation-Card limitation.

8. Tell consumers how to use it

Others consume the bundle with the agent-comms ask primitive, in two forms:

  • /ask <bundle> <question> — slash command, question needs no quotes.
  • bash scripts/agent-comms/ask.sh <bundle> "<question>" — script, question is a single quoted argument.

Omitting the bundle name uses discovery mode, which reads the federation's agent Cards to find a match. See Knowledge-Bundles-Overview.

Quick checklist

  • Instantiated with --agent=claude-code (and --features=agent-comms if publishing)
  • Wiki authored: knowledge + expertise + experience, text-first
  • Index and log current; lint clean; verification gate passing
  • (Optional) knowledge graph builds
  • Wiki pushed to its remote
  • Card published (colons quoted) and picked up by the federation index
  • (Optional) Pages site live and linked from Home
  • No secrets or private data committed; no projections filed as facts

See also

Clone this wiki locally