Remove example notebooks and vignettes; consolidate to examples/vignettes - #45
Merged
Merged
Conversation
Collapse three overlapping "examples" systems into the single CI-tested
set and consolidate the parity documentation.
Examples:
- Keep examples/vignettes/*.py (exercised by tests/docs/test_vignette_examples.py).
- Remove docs/examples/*.py (untested duplicates), docs/examples/notebooks/*.ipynb
(static, stale-prone), and docs/vignettes/*.md (narrative duplicates).
- Move the only still-used asset, boston_housing.csv, to tests/data/ and update
the parity test that reads it.
- Repoint README's Examples section at examples/vignettes and add a run-all note.
Docs:
- Merge docs/parity_{plan,results,status,autofix}.md into a single docs/parity.md
and link it from the README documentation list.
- Update the docs/examples reference in the API-reference generator and its
generated output.
No CI- or sync-tooling-referenced docs were removed.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DZHM4Lz9Z7bfJunct9mJBt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR consolidates the documentation and example structure by removing the Jupyter notebook examples and markdown vignettes from
docs/, while keeping the runnable Python example scripts inexamples/vignettes/. The parity documentation is also streamlined.Key Changes
Removed Jupyter notebooks from
docs/examples/notebooks/:01_partial_moments_risk_workflow.ipynb02_regression_classification_workflow.ipynb04_distribution_dominance_simulation_workflow.ipynb05_boston_housing_regression_workflow.ipynbRemoved markdown vignettes from
docs/vignettes/:00_overview.mdthrough09_portfolio_stochastic_dominance.md)README.mdfor vignettesRemoved standalone example scripts from
docs/examples/:classification.py,dependence.py,distributions_anova.py,forecasting.py,partial_moments.py,regression.pyREADME.mdfor examplesConsolidated parity documentation:
docs/parity_plan.md,docs/parity_results.md,docs/parity_status.md,docs/parity_autofix.mddocs/parity.mdcontaining target, status, and verification instructionsMoved test data:
boston_housing.csvrelocated fromdocs/examples/notebooks/data/totests/data/Updated references:
README.md: Updated examples section to point toexamples/vignettes/examples/run_all_vignettes.py: Removed reference todocs/vignettes/markdowntests/parity/test_practical_examples.py: Updated Boston housing CSV pathRationale
This consolidation reduces documentation duplication and establishes a single source of truth: runnable Python scripts in
examples/vignettes/that are tested in CI. The parity documentation is simplified into one comprehensive file with clear verification steps.https://claude.ai/code/session_01DZHM4Lz9Z7bfJunct9mJBt