Skip to content

Commit f78eac2

Browse files
committed
Add notebook indexing guideline to documentation
1 parent 8d624ba commit f78eac2

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

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
24+
- **Notebook index**: New notebooks must be added to `docs/source/notebooks/index.md` under the appropriate `toctree` section for them to appear in the rendered documentation
2425
- **MyST directives**: Use `:::{note}` and other MyST features for callouts and formatting
2526
- **Glossary linking**: Link to glossary terms (defined in `glossary.rst`) on first mention in a file:
2627
- In Markdown files (`.md`, `.ipynb`): Use MyST syntax `{term}glossary term``

0 commit comments

Comments
 (0)