Skip to content

Simplify README, document Docker setup, and refresh screenshots - #43

Merged
csd113 merged 1 commit into
mainfrom
doc-update
Sep 30, 2026
Merged

csd113 merged 1 commit into
mainfrom
doc-update

Conversation

@csd113

@csd113 csd113 commented Sep 30, 2026

Copy link
Copy Markdown
Owner

RustPost's README mixed first-time setup with a long technical reference. This update explains the app in everyday language, puts the released Docker container setup first, and gives readers clear choices between Docker, a downloaded app, and a source build.

Detailed configuration, Tor, backup safeguards, and release advisory notes are preserved in an operator guide. A Docker guide adds tested settings, storage, backup/restore, and container replacement commands. Five screenshots were recaptured from a fresh v1.0.0 demo, and the demo guide records prerequisites, pages, and viewport sizes.

Validation:

  • cargo build --workspace --all-features --bin rustpost-cli passed.
  • cargo fmt --all --check passed.
  • cargo clippy --workspace --all-targets --all-features -- -D warnings -D clippy::all -D clippy::pedantic -D clippy::nursery -D clippy::cargo passed.
  • cargo test --workspace --all-features passed (487 tests).
  • Published GHCR manifest verified for Linux amd64 and arm64.
  • Released container smoke passed: first boot, interactive administrator creation, HTTP, settings copy/validation, backup, restore, and persistence after container replacement.
  • Documentation links/anchors and code fences checked; all five screenshots visually reviewed; browser console had no errors.

No application code or dependencies changed. Existing upstream dependency caveats remain documented.

@csd113
csd113 merged commit d48c32f into main Sep 30, 2026
7 checks passed
@csd113
csd113 deleted the doc-update branch October 2, 2026 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant