Skip to content

docs(esm_catalog): PR-C3 — add canonical ARCHITECTURE.md#1496

Open
siligam wants to merge 1 commit into
esm-catalog/pr-c2-personal-collectionsfrom
esm-catalog/pr-c3-docs
Open

docs(esm_catalog): PR-C3 — add canonical ARCHITECTURE.md#1496
siligam wants to merge 1 commit into
esm-catalog/pr-c2-personal-collectionsfrom
esm-catalog/pr-c3-docs

Conversation

@siligam

@siligam siligam commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the single canonical src/esm_catalog/ARCHITECTURE.md (1247 lines) to the PR stack.

Background on the case-collision: The collapsed-collections branch inadvertently has both ARCHITECTURE.md (1247 lines, added in "wip: some things for pavan") and architecture.md (499 lines, added later in "feat: experiment hierarchy API"), which differ only by case. On macOS's case-insensitive HFS+/APFS filesystem this causes:

  • The working tree to appear permanently dirty (git always reports one as modified)
  • git rebase/checkout/cherry-pick to fail on clean-tree checks
  • Reviewers on macOS to see inconsistent file content depending on which git show call wins

By only adding ARCHITECTURE.md (uppercase, the more complete version) in the new PR stack and never adding architecture.md, the collision is naturally resolved going forward.

Test plan

  • pytest src/esm_catalog/tests/ — 162 total green (docs-only change, no test impact)
  • Verify git ls-tree HEAD:src/esm_catalog/ | grep -i arch shows exactly one entry
  • CI esm-catalog-tests passes

Stack position

release → PR-0 → A1a → A1b-1 → A1b-2 → A2 → A3 → A4 → B1 → B2 → B3 → B4 → C1 → C2 → C3 (this PR)

Phase C complete after this PR.

🤖 Generated with Claude Code

@siligam
siligam force-pushed the esm-catalog/pr-c2-personal-collections branch from 986cbba to 422c646 Compare June 14, 2026 00:13
@siligam
siligam force-pushed the esm-catalog/pr-c3-docs branch from 2f5a949 to 482b2fb Compare June 14, 2026 00:13
@siligam
siligam force-pushed the esm-catalog/pr-c2-personal-collections branch from 422c646 to e2e2e23 Compare June 17, 2026 12:14
@siligam
siligam force-pushed the esm-catalog/pr-c3-docs branch from 482b2fb to 9a3c072 Compare June 17, 2026 12:14
@siligam
siligam force-pushed the esm-catalog/pr-c2-personal-collections branch from e2e2e23 to 4b1519f Compare June 17, 2026 16:01
@siligam
siligam force-pushed the esm-catalog/pr-c3-docs branch from 9a3c072 to ff8520e Compare June 17, 2026 16:02
@siligam
siligam force-pushed the esm-catalog/pr-c2-personal-collections branch from 4b1519f to 57a7f07 Compare June 17, 2026 16:34
@siligam
siligam force-pushed the esm-catalog/pr-c3-docs branch from ff8520e to d062585 Compare June 17, 2026 16:34
Adds the 1247-line ARCHITECTURE.md to the PR stack. This resolves the
case-collision (ARCHITECTURE.md vs architecture.md) that plagued the
collapsed-collections branch on macOS: by only committing the single
canonical UPPERCASE filename, the new PR stack is collision-free.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@siligam
siligam force-pushed the esm-catalog/pr-c2-personal-collections branch from 57a7f07 to 2eec95a Compare June 17, 2026 17:03
@siligam
siligam force-pushed the esm-catalog/pr-c3-docs branch from d062585 to 51f9859 Compare June 17, 2026 17:03
@siligam

siligam commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Rebased onto the corrected PR-0 base (#1483) — test relocation to tests/test_esm_catalog/, restored dedicated CI workflow at the new path, and a couple of CI fixes (doctest-collection exclusion, eval_type_backport for pydantic on Python 3.9). No change to this PR's own diff/scope. CI is green.

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.

1 participant