Skip to content

Improve documentation information architecture#213

Open
igerber wants to merge 1 commit intomainfrom
claude/improve-docs-architecture-8mBgV
Open

Improve documentation information architecture#213
igerber wants to merge 1 commit intomainfrom
claude/improve-docs-architecture-8mBgV

Conversation

@igerber
Copy link
Owner

@igerber igerber commented Mar 19, 2026

Methodology references (required if estimator / math changes)

  • Method name(s): none/ na. all doc changes
  • Paper / source link(s):
  • Any intentional deviations from the source (and why):

Validation

  • Tests added/updated:
  • Backtest / simulation / notebook evidence (if applicable):

Security / privacy

  • Confirm no secrets/PII in this PR: confirmed

Restructure the Read the Docs sidebar navigation from 3 imbalanced
sections (API/Guide/Tutorials) into 6 balanced sections:

- Getting Started: quickstart, choosing estimator, troubleshooting
- Tutorials: Fundamentals: core DiD methods (basic, staggered, synthetic, etc.)
- Tutorials: Advanced Methods: specialized estimators (TROP, imputation, etc.)
- Tutorials: Study Design: diagnostics & power analysis
- Comparisons & Benchmarks: R/Python comparisons and validation
- API Reference: grouped into Estimators, Diagnostics, Results, Data

Also adds GitHub notebook links to all tutorial pages via nbsphinx_prolog,
updates llms.txt documentation structure to match new IA, and bumps
llms-full.txt version to 2.7.2.

https://claude.ai/code/session_01NNfgCrHLXcg8Pd9cZM3SNC
@github-actions
Copy link

Overall Assessment

✅ Looks good

This PR is documentation/config only. I found no methodology-affecting changes. There is one non-blocking documentation issue: the new notebook banner hardcodes GitHub main, so versioned docs can link users to notebook sources from a different revision than the page they are reading. Assessment is based on source review; I could not run a local Sphinx build because sphinx, nbsphinx, and pydata_sphinx_theme are not installed in this environment.

Executive Summary

Methodology

  • No findings. Affected methods: none. Cross-check against docs/methodology/REGISTRY.md is not triggered beyond confirming the PR does not change any estimator implementation, assumptions, weighting, or inference behavior.

Code Quality

  • No findings.

Performance

  • No findings.

Maintainability

  • No findings. The IA refactor is straightforward, and the category split in docs/api/index.rst:L217-L262 improves scanability without changing content coverage.

Tech Debt

  • No separate tech-debt findings. The notebook-link issue above is not currently tracked in TODO.md, so it remains unmitigated if deferred.

Security

  • No findings. No secrets/PII are introduced, and the added HTML snippet only interpolates repo-controlled document paths.

Documentation/Tests

  • P2 Impact: The notebook admonition always links to https://github.com/igerber/diff-diff/blob/main/..., so users reading stable, tagged, or non-main branch docs can land on notebook sources from a different revision, with examples/API usage that may not match the rendered page. Concrete fix: derive the GitHub ref from the same ReadTheDocs version metadata already read in docs/conf.py:L133-L145 and use that ref in the notebook URL instead of hardcoding main in docs/conf.py:L110-L123.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants