docs: make user-facing guidance self-contained - #315
Merged
Conversation
Replace issue, pull request, and historical-version references in active CLI help, runtime warnings, manpages, README, current release notes, and public Rust documentation with durable behavior-focused guidance. Add help-rendering regression checks for all three binaries so internal tracking references cannot silently return. Validation includes the full workspace test suite with localhost SSH authentication, all 16 actual help paths, product-code Clippy with warnings denied, formatting, and diff checks.
inureyes
added a commit
that referenced
this pull request
Sep 1, 2026
Prepare the bssh package and user-facing release metadata for v3.0.1. This patch release packaged the behavior-focused documentation cleanup from #315 without changing runtime behavior. The internal bssh-russh packages retained their upstream-derived 0.63.1 and 2.4.0 versions. Validation: cargo fmt --all -- --check; cargo check --workspace --all-targets; targeted help regression tests for bssh, bssh-server, and bssh-keygen; cargo build --bins; Debian changelog parsing; manpage rendering.
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
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
Validation
cargo test --workspace --all-targetswith the configured localhost SSH key loaded into a one-shot agentcargo test -p bssh --lib help_uses_current_user_facing_termscargo test -p bssh --bin bssh-server test_cli_parsingcargo test -p bssh --bin bssh-keygen test_cli_parsingcargo clippy -p bssh --lib --bins --all-features -- -D warningscargo fmt --all -- --checkRisk and release