docs: stale-reference sweep — engine rename, Dockerfile, ADR-0007 errata#311
Open
lgahdl wants to merge 2 commits into
Open
docs: stale-reference sweep — engine rename, Dockerfile, ADR-0007 errata#311lgahdl wants to merge 2 commits into
lgahdl wants to merge 2 commits into
Conversation
…ata (#123, #108, #62) - deployment.md: replace the "planned for M5" Dockerfile sketch with a pointer to the real Dockerfile + docker.md; update nexum-runtime log directive examples - qa-signoff.md: nexum-engine → nexum-runtime in crate-dependency row - adr/0007: add errata noting the nexum-engine → nexum-runtime rename and the [patch.crates-io] retirement now that cowprotocol 0.1.0 is on crates.io Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TfSsJPYDQ1GQGbnSVFxATx
Collaborator
|
Nice cleanup! The new text references Since this section cross-references those files and shows the |
jean-neiverth
approved these changes
Jul 10, 2026
…tion.md 3.1 Review catches on the stale-reference sweep itself: - ADR-0007 errata and sdk.md Versioning both claimed cowprotocol is a clean 0.1.0 registry dependency "with no git override". The branch's own Cargo.toml pins 0.2.0 WITH an active [patch.crates-io] override to nullislabs/cow-rs (pending the hash-only OrderCreationAppData constructor release). Both now describe that state and point at the patch-block comment as the source of truth. - production.md 3.1 still shipped the "interim" hand-rolled Dockerfile recipe issue #123 flagged; replaced with a pointer to the real root Dockerfile and docs/deployment/docker.md. - 02-modules-events-packaging.md: un-garble the parenthetical the earlier rename made self-contradictory ("was module.toml in earlier drafts" -> "was nexum.toml"). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TfSsJPYDQ1GQGbnSVFxATx
lgahdl
force-pushed
the
docs/108-62-123-sweep
branch
from
3653ce8 to
4e69f91
Compare
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.
Closes #123, #108, #62
Three-file docs sweep addressing post-rename and post-M5-ship staleness.
Changes
docs/deployment.md— Replace the "Dockerfile is planned for M5" placeholder and sketch block with a pointer to the realDockerfile+docker-compose.ymlat the repo root, and todocs/deployment/docker.mdfor the full container workflow. The M5 milestone shipped; the sketch is misleading to new operators.docs/qa-signoff.md—nexum-engine→nexum-runtimein thewarn(unused_crate_dependencies)check row (line 15).docs/adr/0007-upstream-protocol-logic-to-cow-rs.md— Add errata noting: (1)crates/nexum-engine→crates/nexum-runtime+crates/nexum-clirename, (2)[patch.crates-io]rev-bump mechanism retired oncecowprotocol 0.1.0published to crates.io. ADRs 0001, 0006, and 0009 already carry this errata; 0007 was the remaining gap.What's not changed
docs/sdk.mdVersioning section was already correct (cowprotocol = "0.1.0", no[patch.crates-io]).docs/01-runtime-environment.mdnexum.tomlreferences anddocs/02-modules-events-packaging.mddiagram were already fixed in the M1 train.🤖 Generated with Claude Code
https://claude.ai/code/session_01TfSsJPYDQ1GQGbnSVFxATx