Expose artifact guidance and release v0.11.1 - #20
Merged
Conversation
Context: Agents could reach the artifact guide only by discovering the docs subcommand, opening its help, and guessing the relevant topic. Bare `devloop docs` failed instead of helping, and artifact validation errors did not name the guide. Decision: Make the docs topic optional, render the existing documentation index when it is omitted, advertise the artifact use case in root help, and attach the exact guide command to artifact validation failures. Keep the smoke harness's readiness signal deterministic by selecting its required log level. Alternatives considered: A machine-readable capabilities command would add another public interface without fixing the ordinary help path that agents already inspect. Duplicating a topic index in Rust would let the repository and binary documentation drift. Tradeoffs: Root help gains one targeted hint, and bare `devloop docs` changes from an error to successful output. The index remains intentionally concise and delegates complete contracts to each topic. Architectural impact: The CLI now treats the documentation index as the default docs resource while preserving every existing topic command. Validation keeps its existing rules and adds only actionable context at the artifact boundary. SemVer impact is a backward-compatible patch.
Context: The artifact-guide discoverability fix is backward compatible and ready for a patch release. Tag automation requires the Cargo package version, changelog section, release notes input, and intended tag to agree. Decision: Promote the accumulated `[Unreleased]` fixes into the dated `0.11.1` section, recreate an empty unreleased section, and update Cargo's package and lockfile versions to `0.11.1`. Alternatives considered: Leaving the fixes unreleased would not update installed binaries. A minor version would overstate a discoverability correction that adds no separate feature or incompatible command contract. Tradeoffs: This creates an immediate patch after `0.11.0`, but it makes the artifact workflow usable by agents without relying on repository knowledge. Architectural impact: Runtime architecture is unchanged. Release metadata and the intended `v0.11.1` tag now share one version boundary for protected CI and artifact publication.
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
1 participant
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.
Summary
devloop docsprint a use-case-oriented topic indexdevloop docs artifactsRUST_LOGfilterv0.11.1Validation
cargo fmt --checkcargo testcargo clippy --all-targets --all-features -- -D warningsRUST_LOG=off ./scripts/ci-smoke.sh./scripts/release-notes-from-changelog.sh 0.11.1 pasunboneleve/devloopcargo run --quiet --bin devloop -- --versioncargo run --quiet --bin devloop -- --helpcargo run --quiet --bin devloop -- docsgit diff --checkRoborev job 265 (Codex) reviewed the implementation diff and found no issues.
Kata:
3hxx