docs: stale-reference sweep — engine rename, Dockerfile, ADR-0007 errata#352
Merged
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
…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").
mfw78
added
the
base: dev/m1
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.
What
Docs-only sweep clearing stale references left over from the crate rename and the M5 Docker ship:
docs/deployment.md: replaces the "Dockerfile is planned for M5" placeholder and inline sketch with a pointer to the realDockerfile+docker-compose.ymlat the repo root, and todocs/deployment/docker.mdfor the full container workflow. Notes the image is published toghcr.io/nullislabs/shepherd:<tag>on every merged commit tomain.docs/production.md: replaces the "Dockerfile (interim)" multi-stage sketch and its status note with a pointer to the real rootDockerfile, plus thedocker build/rootdocker-compose.ymlbuild path.docs/qa-signoff.md:nexum-engine->nexum-runtimein thewarn(unused_crate_dependencies)check row.docs/adr/0007-upstream-protocol-logic-to-cow-rs.md: adds errata noting thecrates/nexum-engine->crates/nexum-runtime+crates/nexum-clirename, and that the workspace now pinscowprotocol = "0.2.0"from crates.io with a temporary[patch.crates-io]git override tonullislabs/cow-rspending a release with the hash-onlyOrderCreationAppDataconstructor.docs/sdk.md: updates the versioning section fromcowprotocol = "0.1.0"(no patch) to0.2.0with the same temporary patch override described above.docs/02-modules-events-packaging.md: fixes the manifest-naming aside, the pre-rename filename wasnexum.toml, notmodule.tomlas the earlier draft claimed.Historical ADRs, migration docs, and operations reports that describe what was true at the time are left as-is.
Why
Several docs pages still described planned-but-since-shipped work (the Dockerfile) or pre-rename crate/manifest names (
nexum-engine,nexum.toml), which misleads new operators and reviewers cross-referencing the ADRs against the current tree.Testing
Docs-only change, no build required. Verified crate names against the current workspace
Cargo.tomland confirmed the linkeddocs/deployment/docker.mdand rootDockerfile/docker-compose.ymlexist and match the described workflow.Closes #123, #108, #62