Anatomy of a Document¶
🌐 AI ReaderRead this document in English or ask questions: Open in Claude, ChatGPT, or Gemini ↗
A document is a folder. Its README.md is the page; everything else in the folder is either part of the page or writing material that never reaches the site.
The files of this folder¶
03-ungrouped/document-anatomy/
├── README.md # this page: front matter + body
└── plan.md # the writing plan: kept in git, excluded from the build
A resources/ folder next to plan.md holds the sources a document was written from (articles, transcripts, an exported Confluence page). Like plan.md, it is excluded in conf.py (exclude_patterns), and git ignores it.
The front matter¶
Key |
Meaning |
|---|---|
|
12 random letters, the document’s identity; |
|
Two sentences, double-quoted: what the document says, then what kind of document it is. |
|
Optional keywords |
|
Dates, |
Linking to it¶
Every link is built from the doc_id, so moving or renaming the folder breaks nothing: Anatomy of a Document links to this page, and /p/NaHsHTYtOvMO redirects to it on the live site. Agents read its plain text at /p/NaHsHTYtOvMO.md.