Skip to content

Docs: re-shelve into design/, history/, research/, and a changes.md - #1

Merged
cekees merged 2 commits into
mainfrom
docs-reshelve
Nov 2, 2026
Merged

cekees merged 2 commits into
mainfrom
docs-reshelve

Conversation

@cekees

@cekees cekees commented Nov 1, 2026

Copy link
Copy Markdown
Owner

First PR of the ymf cleanup (C42 step 0, layout approved by cekees 2026-11-01). Docs only: no code changed beyond doc paths in comments.

The docs directory mixed the two guides with superseded drafts, a session log and unverified research. Its index called the v0.1 draft "the best statement of the design principles" after two of them had been dropped. This sorts the files by what they are.

Was Now Header added
design-time-outside-space.md design/time-outside-space.md Implemented (ymf#22/proteustoolkit#23, cekees/proteus#109/#110); § 8 answered by cekees/proteus#121
ymf-schema.md history/schema-v0.1.md what replaced each part; § 3 is still the only vvuq sketch
ymf-schema-v0.2-delta.md history/schema-v0.2-delta.md a changelog of what ymf.schema implements
session-summary-2026-07-29.md history/session-2026-07-29.md history, nothing current
ymf-units-report.md, data-sources-report.md, csdms-bmi-report.md research/units.md, research/data-sources.md, research/csdms-bmi.md research caution; the CSDMS errors move into that file
(none) changes.md the closed gaps, dated, with the commit that closed each

Other changes:

  • Known gaps keeps only open gaps. There are 5. Two of them are remnants that sat inside closed entries: flux-condition units, and duplicates that restate a boundary speed. The closed entries move to changes.md. So do the two C27 decisions that were recorded only outside the repo: composition may remove, and numbers and expressions are treated the same way.
  • Boundary-condition behaviour moves into the guide body. This covers the Neumann sign, Robin, and the series value form. "Only on a box" was stale, because only periodic conditions need a box (symbolic/problem.py).
  • Archive guide and README. Proteus writes this format on its 2.0 line, not "the ymf_io branch". The guide now says the solver's tree is called domain in a solver document and approximation in an output. The rename itself is a later PR.
Check Before After
pytest tests (petsc-dev env, macOS arm64) 596 passed, 2 skipped 596 passed, 2 skipped
broken relative links or anchors in README.md and docs/ not measured 0

Not changed here: examples/notebooks/ still name the old paths, and PR 5 removes them. In proteus, test/test_archive_instants.py cites the old path of the time-outside-space note in a comment, which needs a one-line follow-up.

🤖 Generated with Claude Code

The docs directory mixed the two guides with superseded drafts, a session
log and unverified research, and the index called the v0.1 draft "the best
statement of the design principles" after two of them were dropped. This
sorts them by what they are, with no change to any guide's content beyond
moving closed gaps out.

- design/time-outside-space.md: status says implemented (ymf#22/proteustoolkit#23,
  proteus#109/#110) and that both § 8 questions were answered by
  cekees/proteus#121.
- history/: schema-v0.1, schema-v0.2-delta, session-2026-07-29, each with
  a header saying what replaced it.
- research/: units, data-sources, csdms-bmi; the csdms errors move from
  the index into the file's own header.
- changes.md (new): the closed Known-gaps entries, dated, with the commit
  that closed each, plus the two C27 decisions recorded only outside the
  repo until now (composition may remove; numbers and expressions
  treated uniformly).
- problem-specification.md: Known gaps keeps only open gaps (5, two of
  them the remnants left inside closed entries). The boundary-condition
  behaviour that lived there (Neumann sign, Robin, series) moves into the
  body. "Only on a box" was stale: only periodic needs a box.
- archive-format.md, README: Proteus writes this on its 2.0 line, not "the
  ymf_io branch"; say that the solver's tree is called domain in a solver
  document and approximation in an output.
- Doc paths in source comments updated. No code changed.

Checked: every relative link and anchor in README.md and docs/ resolves
(0 broken). Tests: 596 passed, 2 skipped, before and after (petsc-dev env,
macOS arm64).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cekees cekees closed this Nov 1, 2026
@cekees cekees reopened this Nov 1, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cekees cekees closed this Nov 1, 2026
@cekees cekees reopened this Nov 1, 2026
@cekees
cekees merged commit c90d0ac into main Nov 2, 2026
7 checks passed
@cekees
cekees deleted the docs-reshelve branch November 2, 2026 09:50
cekees added a commit to proteustoolkit/ymf that referenced this pull request Nov 2, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
cekees added a commit to proteustoolkit/ymf that referenced this pull request Nov 2, 2026
ymf cleanup: docs re-shelved, dead schema keys refused, model/approximation naming (cekees#1–#5)
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