Skip to content

Learn [[learn: __Namespace]]

🤖 Content Generator

Prompt [[learn_gen_prompt: text]]text

Generate the landing/overview page for the Learn (explanation) section of the QMDC docs. It must orient a reader and give them a sensible reading order.

Query each about: object for its goal and audience fields (via qmdc query) and build the descriptions from those — do not invent them.

Structure the content as:

  1. A short intro (2–3 sentences): explanations give background and reasoning (Diátaxis sense) — what QMDC is, why it exists, how the pieces fit. They serve understanding, and can be read away from the keyboard.
  2. A brief "where to go" paragraph that routes the reader: need to do something specific? see the Guides; just getting started? work through the Tutorials first. Link those namespaces with QMD references.
  3. A section "## Reading path": a numbered list in this order — Why QMDC, Markdown to Graph, Human Text, Machine Structure, QMDC for Agents, QMD.md vs Quarto's QMD — each linked with its QMD reference and a one-line description from its goal.
  4. A final section "## At a glance" containing a single live table block: a fenced code block whose language is table, with first line scope: all and a sql: block running SELECT __label as Topic, json_extract(data, '$.goal') as Goal FROM objects WHERE __namespace = 'learn' AND __kind = 'Explanation' ORDER BY __label.

Audience: newcomer — plain language, no jargon. Keep it concise and scannable.

The Learn section explains the ideas behind QMDC — what it is, why it exists, and how the pieces fit together. These pages are for understanding; read them away from the keyboard whenever you want the bigger picture.

If you need to accomplish something specific right now, jump to the Guides. If you're brand new, work through the Tutorials first and come back here when you want the "why" behind the steps.

Reading path

  1. Why QMDC — understand what problem QMDC solves and who it is for
  2. Markdown to Graph — see how plain Markdown headings and lists become a queryable graph
  3. Human Text, Machine Structure — understand QMDC's dual nature — readable docs and queryable data at once
  4. QMDC for Agents — understand how AI agents benefit from a queryable QMDC workspace
  5. QMD.md vs Quarto's QMD — understand how QMD.md differs from Quarto's QMD and why they don't compete

At a glance

Topic Goal
Human Text, Machine Structure understand QMDC's dual nature — readable docs and queryable data at once
Markdown to Graph see how plain Markdown headings and lists become a queryable graph
QMD.md vs Quarto's QMD understand how QMD.md differs from Quarto's QMD and why they don't compete
QMDC for Agents understand how AI agents benefit from a queryable QMDC workspace
Why QMDC understand what problem QMDC solves and who it is for