Amend.sh Docs
Build a source-linked product update loop from feedback to shipped customer communication.
Amend connects four things teams usually keep apart: customer asks, source evidence, roadmap state, and shipped updates. These docs are for the person wiring that loop into a real product, with enough detail for a maintainer or coding agent to verify what is actually running.
Start Here
Quickstart
Prove one complete update path: request, source event, review, publish.
Source trace
Understand the evidence model behind every roadmap and changelog move.
Integration
Choose the right path for portal, SDK, REST, source imports, and automation.
API reference
See the beta REST and SDK contract by job, auth level, and route family.
Self-hosting
Bring your own Convex deployment, provider keys, domains, and model policy.
Production routing
Serve docs from docs.amend.sh and make amend.sh/docs work through Vercel.
Launch
Check provider credentials, DNS, Convex, email, billing, and final gates.
The Loop
| Stage | Inputs | Output | Read next |
|---|---|---|---|
| Intake | Portal feedback, SDK calls, support and app events | Normalized requests with user/account IDs | Customer surfaces |
| Evidence | GitHub PRs, releases, issues, labels, imports | Source events tied to projects and requests | Source events |
| Review | Automation rules, confidence, owner edits | Draft roadmap, changelog, and delivery work | Automation |
| Publish | Portal settings, preferences, verified domains | Public updates and targeted notifications | Production routing |
First Production Shape
For the hosted Amend launch, keep the production surfaces explicit:
| Surface | Production origin | Why it exists |
|---|---|---|
| Web app | https://amend.sh | Marketing, auth, dashboard, portal, embed demo |
| Docs | https://docs.amend.sh/docs | Canonical Fumadocs site, search, schemas, llms |
| Proxy | https://amend.sh/docs | Main-site entry point that opens the docs route |
| API | https://<convex-deployment>.convex.site | Convex HTTP actions under /api/v1 |
Non-Negotiables
- Do not publish customer-facing updates without a source trace.
- Do not put provider secrets, owner API tokens, private keys, or webhook secrets in the client.
- Do not treat a local portless URL as proof that DNS, Vercel routing, auth callbacks, or webhooks work in production.
- Do not hardcode docs links in product code. Use
VITE_DOCS_URL. - Do not let automation silently publish public copy until workspace rules and confidence thresholds say that is allowed.