Skip to content

docs: align the docs with the current web UI, CLI and API - #152

Merged
xsmyile merged 2 commits into
masterfrom
docs/refresh-web-ui-docs
Oct 7, 2026
Merged

xsmyile merged 2 commits into
masterfrom
docs/refresh-web-ui-docs

Conversation

@xsmyile

@xsmyile xsmyile commented Oct 7, 2026

Copy link
Copy Markdown
Member

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.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ 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.

Pullfrog  | Fix all ➔ | Fix 👍s ➔ | View workflow run | Using gpt-6.1-sol | 𝕏

Comment thread docs/features/webhooks.md Outdated

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes Reviewed the documentation correction in 782bfc0 against the webhook startup validator.

  • Clarified webhook restrictions Scoped startup rejection to localhost and 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.

Pullfrog  | View workflow run | Using gpt-6.1-sol | 𝕏

@xsmyile
xsmyile merged commit 3559eb3 into master Oct 7, 2026
3 checks passed
@xsmyile
xsmyile deleted the docs/refresh-web-ui-docs branch October 7, 2026 08:53
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