Examples
This directory holds the database of paper examples cited across the guide.
Files
| File | Purpose |
|---|---|
examples.yaml | Structured database: one entry per cited paper, indexed by chapter. The single source of truth. |
papers-to-read.bib | BibTeX file of every paper cited in Chapter 30. Drop into Overleaf. |
Why YAML?
The chapter files cite examples in prose, and the same paper often appears in two or three chapters. With the canonical entry in examples.yaml:
- One place to update if a paper's link changes or it gets a Best Paper Award we should note.
- Tools can render it. The Docusaurus site can generate example cards from this file, and future translators can keep titles synced.
- Contributions are simpler. Adding a paper means editing one YAML block instead of hunting for the right paragraph in prose.
How to add a paper
Read CONTRIBUTING.md first. Summary:
- Add the entry to
examples.yamlin the correct chapter section, alphabetized within the chapter. - Verify the anthology_url resolves.
- Add the BibTeX to
papers-to-read.bibif the paper belongs in Chapter 30. - Reference the example in the relevant chapter markdown file. The cap is five examples per section. If you add one, propose which one to swap out.
Schema
- chapter: <slug> # title, abstract, introduction, methods, results, ...
paper: <full title>
authors: <comma-separated, "et al." for >3>
venue: <short venue + year>
anthology_url: <URL or null>
exemplifies: <one sentence — what this paper does well>
notes: <optional longer commentary>