mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-04 21:04:37 +08:00
9f13d410fc
[Open this suggestion in Promptless to view citations and reasoning process](https://app.gopromptless.ai/change-history/e6033b34-4005-4a9e-9d21-d809e2d57896) Adds documentation for the two new built-in email templates: `payment_receipt` (sent when payments succeed) and `payment_failed` (sent when payments fail). Updates the Emails guide to list these new templates alongside existing authentication templates, and adds a "Payment Emails" section to the Payments guide explaining that these notifications are sent automatically for both one-time purchases and subscription renewals. ### Trigger Events <details> <summary><a href="https://github.com/stack-auth/stack-auth/pull/1106">stack-auth/stack-auth PR #1106: payment email templates</a></summary> <br> **Promptless Research** (1 GitHub PR) - [Reviewed stack-auth/stack-auth#1106](https://github.com/stack-auth/stack-auth/pull/1106) **Agent Response** > I've completed the documentation updates for PR #1106. Here's a summary of the changes: > > ## Documentation Suggestion Created > > **Title:** Document payment email templates > > **Changes made:** > > 1. **Emails guide** (`docs/content/docs/(guides)/apps/emails.mdx`): > - Added `payment_receipt` and `payment_failed` to the "Built-in Email Templates" section, keeping them consistent with the existing format for other templates > > 2. **Payments guide** (`docs/content/docs/(guides)/apps/payments.mdx`): > - Added a new "Payment Emails" subsection under Dashboard Management explaining that Stack Auth automatically sends email notifications when payments are processed > - Documents both templates with their key details (receipt link, failure reason, etc.) > - Notes that these apply to both one-time purchases and subscription renewals > - Includes a pointer to where templates can be customized > > The suggestion is ready for review at: https://app.gopromptless.ai/change-history/e6033b34-4005-4a9e-9d21-d809e2d57896 </details> --- **Help us improve Promptless** — If this suggestion missed the mark, please [share quick feedback](https://app.gopromptless.ai/change-history/e6033b34-4005-4a9e-9d21-d809e2d57896?openFeedback=1). *If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)* Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com> Co-authored-by: Madison <madison.w.kennedy@gmail.com> |
||
|---|---|---|
| .. | ||
| code-examples | ||
| content/docs | ||
| lib | ||
| public | ||
| scripts | ||
| src | ||
| templates-api | ||
| .env.development | ||
| .eslintrc.json | ||
| .gitignore | ||
| cli.json | ||
| instrumentation-client.ts | ||
| next.config.mjs | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| source.config.ts | ||
| tsconfig.json | ||
Stack Auth Documentation
This is the documentation site for Stack Auth, built with Next.js and Fumadocs.
Development
pnpm dev
The docs server runs on port 8104 by default (or ${NEXT_PUBLIC_STACK_PORT_PREFIX}04).
Project Structure
Content (/content)
| Directory | Description |
|---|---|
content/docs/ |
Main documentation (guides, SDK reference, components) |
content/api/ |
REST API reference documentation |
App Routes (/src/app)
| Route | Description |
|---|---|
/docs |
Main documentation pages |
/api |
API reference pages (rendered from OpenAPI specs) |
/docs-embed |
Embedded docs for dashboard companion widget |
/api-embed |
Embedded API docs for dashboard companion widget |
/mcp-browser |
MCP documentation browser |
/handler/[...stack] |
Stack Auth handler route |
/api/search |
Search API endpoint |
/api/chat |
AI documentation chat endpoint |
/llms.txt |
LLM-friendly documentation (plain text) |
/llms.mdx |
LLM-friendly documentation (MDX format) |
SDK Route Handlers
These routes serve SDK-specific documentation:
/js/[...path]- JavaScript SDK/next/[...path]- Next.js SDK/react/[...path]- React SDK/python/[...path]- Python SDK/rest-api/[...path]- REST API
Key Files
| File | Description |
|---|---|
lib/source.ts |
Content source adapter using Fumadocs loader() |
source.config.ts |
Fumadocs MDX configuration (frontmatter schema, etc.) |
app/layout.config.tsx |
Shared layout options |
lib/platform-config.ts |
Platform/framework configuration for code examples |
Components (/src/components)
| Directory | Description |
|---|---|
api/ |
API playground components |
chat/ |
AI chat interface |
layout/ |
Layout UI components (search, navigation) |
layouts/ |
Page layouts (docs, API) |
mdx/ |
Custom MDX components |
stack-auth/ |
Stack Auth demo components |
ui/ |
Base UI components (button, etc.) |
OpenAPI Specs (/openapi)
Contains OpenAPI JSON specifications organized by access level:
client-*.json- Client-side API endpointsserver-*.json- Server-side API endpointsadmin-*.json- Admin API endpointswebhooks-*.json- Webhook event schemas
Scripts
# Generate API docs from OpenAPI specs
pnpm generate-openapi-docs
# Clear generated docs
pnpm clear-docs