Skip to content

TableOfContents

TableOfContents shows the whole argument before the reader commits to any of it: one row per section, each row a link carrying the section name and its one-line gist. Big Plan completes the overview at render time with slide numbers, section links, and group headers derived from the plan’s Part dividers, so the author writes only the entries.

Place one TableOfContents directly after the QuickSummary, before the first Part or section. Skip it only in a very short plan whose sidebar navigation already tells the whole story.

<TableOfContents>
<Entry section="Status quo" gist="Inline retries couple checkout latency to processor health" />
<Entry section="Success looks like" gist="A restart never loses a scheduled retry" />
<Entry section="The retry queue" gist="A queue worker with explicit state and bounded backoff" />
</TableOfContents>
  • At least one self-closing Entry, each with required non-empty section and gist attributes; loose body content is rejected.
  • section must repeat each section’s overview form exactly, in order, one to one: the catalog name for most typed Slide instances, a user journey’s ultra-concise toc attribute, or the h2 title for an untyped slide. The table-of-contents-matches-sections linting rule enforces the match.
  • No attributes on TableOfContents itself.

Each violation fails validate and render with a positional diagnostic. Run big-plan guidance TableOfContents for judgment-level usage guidance.