Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Editing This Book

This chapter is for maintainers — humans and agents who change the Skill Book or reverse-engineering guides. The Skill Book is our internal knowledge store: contract for skills, operational playbooks, and methodology we expect every contributor (and every future session) to rely on.


Before you edit anything

  1. Read the Introduction through once — it orients repos, audiences, and where to look next.
  2. Skim docs/SUMMARY.md (the table of contents mdBook uses). On the published site, that is the sidebar. You should know what already exists so you do not duplicate or contradict it.
  3. If your change affects skill contracts or validation, follow the Contributing section in the repo README.md and run the checks it lists (npm run validate, mcp:test, etc.).

Tooling

GoalCommand
Local preview with reloadmdbook serve (opens a local server; default port 3000)
One-shot buildmdbook build — output in target/book/
CI / GitHub PagesWorkflow .github/workflows/book.yml runs mdbook build on pushes that touch docs/** or book.toml

Config lives in book.toml at the repo root. Chapter sources live under docs/; navigation order is docs/SUMMARY.md only — a file not linked from SUMMARY.md is omitted from the built book.


Linking rules (mdBook)

  • Use .md paths in source for pages inside this book (e.g. [Auth](skills/connections.md)). mdBook rewrites them to .html in target/book/.
  • Do not hand-author .html links in markdown — they break GitHub’s markdown preview and confuse local editing.
  • Chapter files in a folder: name the main file index.md, not README.md. mdBook emits index.html for README.md sources but still rewrites markdown links to README.html, which does not exist — readers get a broken page (often without book chrome/CSS). This is a long-standing mdBook limitation. The reverse-engineering layers use index.md for that reason.
  • Anchor links work in source as page.md#section-id and carry through to the built HTML.
  • Paths outside docs/ (e.g. skills/exa/readme.md) are not part of the book build; those links are for people browsing the repo on GitHub. On the static site they may not resolve — prefer linking to the GitHub tree URL when the audience is web readers.

What to update when you change the product

ChangeAlso update
New or renamed skillSkill Catalog, skill readme.md, and any chapter that lists examples
Auth / credential behaviorAuth Flows, Connections & Auth, relevant reverse engineering sections
New reverse-engineering methodologyAppropriate layer under docs/reverse-engineering/ — keep cross-links between layers consistent
Contract / schema / lint rulesSkill Anatomy, Operations, Testing, and repo validation docs

Ship doc updates in the same change as behavior when possible. Stale docs cost the next person (or the next agent) more than missing docs.


Style

  • Prefer examples over theory — link to real skills (skills/exa/, skills/kitty/, etc.).
  • Prefer short sections with clear headings so deep links stay stable.
  • Skill readmes (skills/<name>/readme.md) are living docs; keep them aligned with the YAML and code.

When in doubt, add a link from Introduction or this chapter so the next editor finds your material.