chore: src-layout, notebooks→examples, distribute working docs out of root - #49
Merged
Conversation
… root
Repo hygiene for the 3.4.0 release; no change to the installed package.
- src-layout: mir/ -> src/mir/ (hatch packages=["src/mir"] maps it to `mir` at the
wheel root; import name and API unchanged). Coverage/omit paths + docs sys.path updated.
- notebooks/ -> examples/ (the [examples] extra + docs/examples page updated).
- Removed the working result/plan docs from the repo root, distributed to the sibling
repos: THEORY.md -> 2026-mirpy-ms; BENCHMARKS.md, REPERTOIRE_{EMBEDDING,LESSONS}.md,
SQRT_D_MIGRATION.md, ROADMAP.md -> 2026-mirpy-analysis/benchmarks/. Root keeps
README/CHANGELOG/CLAUDE/SOURCES. README/docs/CLAUDE references repointed.
Verified: 131 passed / 6 skipped (fast tier) in the uv .venv; zero-warning Sphinx
build; py3-none-any wheel (mir/ at root, resources bundled) + twine check PASSED.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Repo hygiene for the 3.4.0 release — no change to the installed package (import name, API, and wheel contents are identical).
Changes
mir/→src/mir/. Hatchpackages = ["src/mir"]maps it tomirat the wheel root; verified the built wheel hasmir/__init__.pyat root,mir/cli.py, and bundledmir/resources/…, with nosrc/leak. Coverage omit-paths +docs/conf.pysys.path updated.notebooks/→examples/(the[examples]extra + the docs examples page updated).experiments/-path dupes were here):THEORY.md→2026-mirpy-ms(beside the theory appendix).BENCHMARKS.md,REPERTOIRE_EMBEDDING.md,REPERTOIRE_LESSONS.md,SQRT_D_MIGRATION.md,ROADMAP.md→2026-mirpy-analysis/benchmarks/.README/CHANGELOG/CLAUDE/SOURCES. README/docs/CLAUDE references repointed to the sibling repos.Verification
.venv): 131 passed, 6 skipped.py3-none-anywheel +twine checkPASSED.Folds into the unpublished 3.4.0 (CHANGELOG updated under 3.4.0 → Changed).
🤖 Generated with Claude Code