Examples

This directory holds the structured database of paper examples cited throughout 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 27. Drop into Overleaf.

Why YAML?

The per-chapter markdown files reference examples as prose, but the same paper is often cited in two or three chapters. Keeping the canonical entry in examples.yaml means:

1. One place to update if a paper's link changes or it gets a Best Paper Award we should note.
2. Tools can render it — the Docusaurus site can generate example cards from this file; future translators can keep titles synced.
3. Contributions are simpler — adding a paper is editing one YAML block, not finding the right paragraph in prose.

How to add a paper

Read CONTRIBUTING.md first. Summary:

1. Add the entry to examples.yaml in the correct chapter section, alphabetized within the chapter.
2. Verify the anthology_url resolves.
3. Add the BibTeX to papers-to-read.bib if the paper belongs in Chapter 27.
4. Reference the example in the relevant chapter markdown file. 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>