Repository navigation
docs: align the docs with the current web UI, CLI and API - #152
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
ℹ️ One documentation correction inline; no runtime regressions found.
Reviewed changes Reviewed the documentation refresh and replacement screenshot against the current implementation.
- Web UI Updated palette descriptions, keyboard focus behavior, and the screenshot.
- CLI and setup Corrected assertion options, the default database location, version examples, and size estimates.
- API and delivery Updated assertion defaults, webhook/WebSocket payloads, connection lifecycle, release TLS behavior, and the SMTP delivery diagram.
gpt-6.1-sol | 𝕏
Contributor
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes Reviewed the documentation correction in 782bfc0 against the webhook startup validator.
- Clarified webhook restrictions Scoped startup rejection to
localhostand private/reserved IP literals, explicitly noting that hostnames are not resolved and can point to those addresses.
No tests were run because the delta changes documentation only.
gpt-6.1-sol | 𝕏
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.

Reshoots the web UI screenshot with the oxide RustMail palette and fixes stale statements: palette descriptions, focus outline, default database path, binary and image sizes, WebSocket and webhook payloads, assertion defaults, release TLS, assert flags and the architecture diagram.