Skip to content

Docs: README updates — inbox (server) terminology and dashboard links#30

Merged
jm-mailosaur merged 4 commits into
mainfrom
docs/readme-phase-1b
May 27, 2026
Merged

Docs: README updates — inbox (server) terminology and dashboard links#30
jm-mailosaur merged 4 commits into
mainfrom
docs/readme-phase-1b

Conversation

@jm-mailosaur
Copy link
Copy Markdown
Contributor

@jm-mailosaur jm-mailosaur commented May 27, 2026

Summary

  • README content improvements and clearer structure, including better documentation of message codes.
  • Adopt inbox (server) terminology throughout the prose: lead with the product UI term "inbox" and gloss "(server)", so the documentation matches what users see in the dashboard.
  • Update dashboard links for the new layout: API keys are managed at /app/keys, and an inbox's (server's) domain — from which the ID is derived — is read from the inbox (server) itself at /app/servers. The obsolete combined "API tab" (/app/project/api) is removed.

Scope

  • Documentation only — no code, public API, or behaviour changes.
  • Code identifiers and the MAILOSAUR_SERVER environment variable are unchanged.

Lead with the UI term "inbox" and gloss "(server)" on entity mentions,
leaving code identifiers, dashboard field labels, and the MAILOSAUR_SERVER
env var unchanged.
@jm-mailosaur jm-mailosaur changed the title Docs: README updates and inbox (server) terminology Docs: README updates — inbox (server) terminology and dashboard links May 27, 2026
@jm-mailosaur jm-mailosaur merged commit 34b9d1d into main May 27, 2026
6 checks passed
@jm-mailosaur jm-mailosaur deleted the docs/readme-phase-1b branch May 27, 2026 10:02
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.

2 participants