Skip to content

docs(herald): product documentation#22

Merged
coopbri merged 1 commit into
masterfrom
docs/herald-product-docs
Jun 23, 2026
Merged

docs(herald): product documentation#22
coopbri merged 1 commit into
masterfrom
docs/herald-product-docs

Conversation

@coopbri

@coopbri coopbri commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the Herald product docs section under content/docs/core/herald/.

Pages

  • quickstart — key → verify domain → send (REST + GraphQL)
  • api-keysfull/sending levels, expiry, rotation
  • domains — add + DKIM-verify a sending domain
  • templates — Handlebars variables, escaping, preview, broadcasts
  • tracking — open/click tracking, tenant defaults, track.send.omni.dev
  • webhooks — event types, HMAC-SHA256 signing, durable retries + replay
  • sdk@omnidotdev/herald facade + herald-mcp tools

Joins the existing overview/architecture pages; navigation ordered via meta.json. Grounded in the shipped API.

Verification

fumadocs-mdx compiles clean; biome clean on the section; internal links resolve.

Adds the Herald docs section: quickstart, API keys, sending domains,
templates and variables, open/click tracking, webhooks, and the SDK/MCP
server, alongside the existing overview and architecture pages. Navigation
ordered via meta.json. Grounded in the shipped API (REST + GraphQL).
@coopbri coopbri merged commit 48d4ee4 into master Jun 23, 2026
@coopbri coopbri deleted the docs/herald-product-docs branch June 23, 2026 20:11
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 23, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant