Skip to content

Docs: AhaSend Markup (AhaML) reference, and template reads of the working copy - #41

Merged
farhadhf merged 2 commits into
mainfrom
docs/ahaml
Oct 26, 2026
Merged

farhadhf merged 2 commits into
mainfrom
docs/ahaml

Conversation

@farhadhf

Copy link
Copy Markdown
Contributor

Summary

The AhaSend Markup (AhaML) reference page, and the API pages for the AhaML release.

 send-api/
+  ahaml.mdx                      the AhaML reference (copied from the renderer's page)
 api-reference/templates/
   get-template.mdx               returns the working copy (the draft while one exists)
+  get-published-template.mdx     the copy sends use
-  get-template-draft.mdx         removed; redirects to get-template
 template, campaign template, campaign create/update pages
                                  content.markup, and no "dashboard only" for Simple Editor designs
 openapi.yaml                     copied from the server
 changelog.mdx                    AhaML, Get Published Template, the Get Template change

The openapi.yaml copy also carries the segment endpoints and the webhook event settings of the same release.

Evidence

  • docs_lint.py, validate_schema.py, mint validate, mint broken-links and test_docs_checks.py (36 checks) pass.

Merge Danger

Door: two-way

Merge when the API release that ships AhaML is live: before it, the pages describe endpoints and fields the API does not have. If the release ships in November, move the changelog entries to a November block.

Blast Radius: docs

/api-reference/templates/get-template-draft redirects to Get Template.

…king copy

The API reads and writes Simple Editor designs as AhaML, so the AhaML
reference joins "Sending with the API", copied from the page the renderer
makes. The template, campaign template and campaign pages say that
content.markup sets the Simple Editor, how it combines with html and text,
its size limit, URL rules and errors, and no longer say these designs can
change only in the dashboard. What the MCP server can do changes with its
own release.

Get Template now returns the working copy, the draft while one exists, and
the new Get Published Template returns the copy sends use. The Get Template
Draft page goes, with a redirect to Get Template, and the pages that linked
it point at the two reads. The API spec is copied from the server, and the
changelog names the change.
…ot checked

The spec is the one devel shipped to master with: the Go and TypeScript
samples for the AhaML writes and the published template read, the 503 text
that names the campaign case, and the rule that html sent beside markup is
ignored without any check. The Update Template page says the same.
@farhadhf
farhadhf merged commit 5e72092 into main Oct 26, 2026
2 checks passed
@farhadhf
farhadhf deleted the docs/ahaml branch October 26, 2026 18:55
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