Skip to content

[AI-Assisted] docs(cookbook): add executable process recipe - #3881

Draft
EvenSol wants to merge 4 commits into
masterfrom
docs/d163-process-cookbook-2499
Draft

EvenSol wants to merge 4 commits into
masterfrom
docs/d163-process-cookbook-2499

Conversation

@EvenSol

@EvenSol EvenSol commented Sep 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

Advances #2499 D163 with an executable process-cookbook foundation.

  • Clarifies that the existing Python recipes are ordered session fragments sharing feed and process state.
  • Adds one complete Java 8/Log4j2 separator–compressor–cooler screen.
  • Adds physical assertions for mass closure, compressor power, discharge pressure, cooler temperature, and duty.
  • Adds a focused contract that extracts the exact Markdown fence, verifies current public signatures, compiles it with the Java 8 language target, enables assertions, and executes it.
  • Indexes the executable route from the cookbook landing page.

Frozen scope

Exactly four files and four commits:

  • docs/cookbook/process-recipes.md
  • docs/cookbook/index.md
  • src/test/java/neqsim/documentation/ProcessRecipesDocumentationTest.java
  • docs/test_process_recipes_documentation.py

No production, numerical, serialization, public-API, dependency, workflow, notebook, generated-catalog, release, MCP, DEXPI, or Huldra change.

Engineering boundary

This is a process-screening example, not vendor selection, mechanical design, relief design, an operability proof, or final facility design. The guide requires users to inspect phase/equipment state and validate the thermodynamic model, binary interaction parameters, compressor chart, and service limits.

Validation

Current source confirms the unit-aware and stream APIs used by the example. Hosted documentation/search, pre-commit, Spotless, CodeQL, Javadocs, and Java 8/21 suites are pending on the exact publication head.

STATUS: VALIDATION PENDING REPAIRED EXACT-HEAD CI.

Exact base: 5c0d6f4663e94117d764d3c417642775210e70bf
Initial publication head: 83a87709f451399264210541b75a84eac3068c9c
Repaired exact head: bae9e1e7790b00e335cd36e09c038c17349bd76a
Capability contract: #2499 (comment)
Autonomous implementation occupancy: 4 / 10

This PR must remain draft. Do not merge, mark ready, rebase, synchronize, close, replace, abandon, or expand the frozen scope as part of the campaign.

Single attributable repair

The initial exact head exposed two branch-owned gate failures: the existing Python cookbook contract assumed every fenced block was Python, and Spotless required one deterministic assertion reflow. The repair updates that existing contract to count and constrain both Python and Java fences, and applies the exact hosted Spotless artifact 10624920349 (archive SHA-256 f093e688fffa8980e5fa7852b37cce69cb82c1bbe716ebe942f100538586f277; formatted Java blob afc5b1da67328d2b0372ccc3121f137486719399). No example, assertion, API, engineering boundary, or production code changed. The single repair allowance is consumed.

Repaired-head validation checkpoint

At exact head bae9e1e7790b00e335cd36e09c038c17349bd76a, pre-commit and Spotless pass. Documentation/search fails solely because the repair committed r"...\\\\n..." in the legacy Python fence matcher; it therefore finds zero fenced blocks and reports 40 != 0. The intended expression is the same raw pattern with a single newline escape. CodeQL passes. Javadocs, Java 8/21 model specifications, agent-reference checks, benchmarks, and slow shard 2 pass; the fast suites and three slow shards remain active.

STATUS: VALIDATION BLOCKED BY ATTRIBUTABLE REPAIR DEFECT / REMAINING CI ACTIVE — 3 / 5 WORKFLOW GROUPS PASS.

The single repair allowance is consumed, so the exact head remains frozen. There are no comments, reviews, or unresolved threads. Current autonomous occupancy is 4 / 10.

Final exact-head validation checkpoint

At frozen exact head bae9e1e7790b00e335cd36e09c038c17349bd76a, pre-commit, Spotless, CodeQL, Javadocs, Java 8/21 model specifications, agent-reference checks, agentic benchmarks, Ubuntu and Windows Java 8/21 fast suites, all four Java 21 slow shards, and the executable cookbook contract pass.

Documentation/search remains the sole failed workflow group. Its documentation-contract step fails only because the consumed repair committed a double-escaped newline token in the legacy Python fence matcher; it finds zero fenced blocks and reports AssertionError: 40 != 0. The intended raw regular expression differs by one backslash.

STATUS: VALIDATION BLOCKED BY ATTRIBUTABLE REPAIR DEFECT — 4 / 5 WORKFLOW GROUPS PASS.

The PR remains draft, mergeable, exactly four files and four commits, with no comments, reviews, or unresolved threads. Current master is seven path-disjoint commits beyond the exact base; that lag is preserved without rebase or synchronization. Autonomous implementation occupancy is 3 / 10.

The single repair allowance is consumed. Preserve this exact head; no second repair, D164 start, merge, ready-state transition, rebase, synchronization, close, replacement, abandonment, production-code change, notebook, release, MCP, DEXPI, or Huldra action.

D163 continuity monitor — master 03de75e5

The frozen head bae9e1e7790b00e335cd36e09c038c17349bd76a remains unchanged, draft, mergeable, and blocked only by the consumed repair's double-escaped newline in the legacy Python fence matcher. The exact-head workflow result is unchanged: four of five workflow groups pass, including the complete Java/Javadocs matrix.

Current master 03de75e5965263a596ccd4c08f84a947dc3d56ef is ten commits beyond exact base 5c0d6f4663e94117d764d3c417642775210e70bf; all ten commits are path-disjoint from the four frozen D163 files. The lag remains preserved without rebase or synchronization. Autonomous implementation occupancy is 7 / 10.

The one-active-PR rule blocks D164 while D163 remains open. No second repair, branch mutation, merge, ready-state transition, close, replacement, abandonment, production-code change, notebook, release, MCP, DEXPI, or Huldra action.

D163 continuity monitor — master e4e9f275

The frozen exact head bae9e1e7790b00e335cd36e09c038c17349bd76a remains unchanged, draft, mergeable, and blocked only by the consumed repair's double-escaped newline in the legacy Python fence matcher. Exact-head validation remains four of five workflow groups passing, including the complete Java/Javadocs matrix.

Current master e4e9f27534870f510203512f912dd3aa2b9cde1d is seventeen commits beyond exact base 5c0d6f4663e94117d764d3c417642775210e70bf; all seventeen commits are path-disjoint from D163's four frozen files. The lag remains preserved without rebase or synchronization. Autonomous implementation occupancy is 8 / 10.

The one-active-PR rule continues to block D164. No second repair, branch mutation, merge, ready-state transition, close, replacement, abandonment, production-code change, notebook, release, MCP, DEXPI, or Huldra action.

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