Skip to content

Commit dba0975

Browse files
committed
update AGENTS.md in terms of glossary links and cross references
1 parent 8f53047 commit dba0975

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

AGENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@
2222
- **Structure**: Notebooks (how-to examples) go in `docs/source/notebooks/`, knowledgebase (educational content) goes in `docs/source/knowledgebase/`
2323
- **Notebook naming**: Use pattern `{method}_{model}.ipynb` (e.g., `did_pymc.ipynb`, `rd_skl.ipynb`), organized by causal method
2424
- **MyST directives**: Use `:::{note}` and other MyST features for callouts and formatting
25-
- **Glossary linking**: Use Sphinx `:term:` directives to link to glossary terms (defined in `glossary.rst`), typically on first mention in a file
25+
- **Glossary linking**: Link to glossary terms (defined in `glossary.rst`) on first mention in a file:
26+
- In Markdown files (`.md`, `.ipynb`): Use MyST syntax `{term}glossary term``
27+
- In RST files (`.rst`): Use Sphinx syntax `:term:`glossary term``
28+
- **Cross-references**: For other cross-references in Markdown files, use MyST role syntax with curly braces (e.g., `{doc}path/to/doc`, `{ref}label-name`)
2629
- **Citations**: Use `references.bib` for citations, cite sources in example notebooks where possible. Include reference section at bottom of notebooks using `:::{bibliography}` directive with `:filter: docname in docnames`
2730
- **API documentation**: Auto-generated from docstrings via Sphinx autodoc, no manual API docs needed
2831
- **Build**: Use `make html` to build documentation

0 commit comments

Comments
 (0)