docs: rewrite README and update documentation site#12
Merged
Conversation
Restructure around quick start with Docker, add feature table, GitHub Action and CLI assert examples, TUI section, and link to docs.rustmail.app. Add Docker pulls and release badges.
Add Terminal UI feature page with usage, options, and keymaps. Update VitePress sidebar and copyright. Add pre-built binaries section to installation. Harden docker-compose with security_opt and restart policy. Fix Docker image size (~8 MB). Update GitHub Action version pin example. Replace REST API feature card with DKIM/SPF/DMARC. Add Docker Hub README.
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
Test plan
make fmt— passmake check— pass (cargo check + tsc)make test— 68 tests pass