Skip to content

docs: make user-facing guidance self-contained - #315

Merged
inureyes merged 1 commit into
mainfrom
fix/user-facing-help
Sep 1, 2026
Merged

docs: make user-facing guidance self-contained#315
inureyes merged 1 commit into
mainfrom
fix/user-facing-help

Conversation

@inureyes

@inureyes inureyes commented Sep 1, 2026

Copy link
Copy Markdown
Member

Summary

  • 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.
  • Rewrite the exit-code strategy documentation and compression caveat in terms of current behavior and operator actions.
  • Add help-rendering regression guards to bssh, bssh-server, and bssh-keygen so internal tracking references cannot silently return.
  • Keep archived pre-3.0 changelog entries and private implementation comments unchanged for historical traceability.

Validation

  • cargo test --workspace --all-targets with the configured localhost SSH key loaded into a one-shot agent
  • cargo test -p bssh --lib help_uses_current_user_facing_terms
  • cargo test -p bssh --bin bssh-server test_cli_parsing
  • cargo test -p bssh --bin bssh-keygen test_cli_parsing
  • cargo clippy -p bssh --lib --bins --all-features -- -D warnings
  • cargo fmt --all -- --check
  • Actual help audit across 16 root, subcommand, and pdsh-compatible paths

Risk and release

  • This changes user-facing text and regression coverage only; command behavior, defaults, exit codes, and transport policy are unchanged.
  • The published v3.0.0 release body was updated separately, while the existing tag and artifacts remain unchanged. Shipping these source and manpage updates requires a later patch release.

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 inureyes added type:docs Improvements or additions to documentation status:review Under review priority:medium Medium priority issue labels Sep 1, 2026
@inureyes
inureyes merged commit fdeb98d into main Sep 1, 2026
5 checks passed
@inureyes
inureyes deleted the fix/user-facing-help branch September 1, 2026 09:01
@inureyes inureyes added status:done Completed and removed status:review Under review labels Sep 1, 2026
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority:medium Medium priority issue status:done Completed type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant