Skip to content

Commit 425aedd

Browse files
jesseouecursoragent
andcommitted
chore: strengthen provider module docs
Add official upstream links across provider-backed modules and mark installable preset paths ready now that their source modules validate. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 26bb9b1 commit 425aedd

130 files changed

Lines changed: 310 additions & 101 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
### Changed
1717

18+
- Added official upstream documentation links across provider-backed modules and cleaned duplicated Mintlify module docs.
19+
- Promoted installable preset manifests from `planned` to `ready` now that their source modules validate.
1820
- Sharpened public positioning around the API SaaS wedge: API keys, usage tracking, rate limits, credits, Stripe billing, docs, and webhooks as editable source.
1921
- Pointed module maintenance skills to installed shared provider, framework, database, SDK, and platform skills.
2022
- Standardized provider adapter registry language and replaced legacy provider wording/paths.

docs/changelog.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ This page mirrors the release changelog and keeps the latest public registry cha
1717

1818
### Changed
1919

20-
1. Sharpened public positioning around the API SaaS wedge: API keys, usage tracking, rate limits, credits, Stripe billing, docs, and webhooks as editable source.
21-
2. Pointed module maintenance skills to installed shared provider, framework, database, SDK, and platform skills.
22-
3. Standardized provider adapter registry language and replaced legacy provider wording/paths.
23-
4. Renamed public command examples to `stackfoundry`.
24-
5. Updated `AGENTS.md` to match the current recipes, readiness, generated-output, and maintenance-skill model.
25-
6. Improved README badges, contribution controls, provider request templates, repo topics, and docs navigation for public discovery.
26-
7. Updated GitHub Actions dependencies for checkout, Node setup, pnpm setup, and dependency review.
20+
1. Added official upstream documentation links across provider-backed modules and cleaned duplicated Mintlify module docs.
21+
2. Promoted installable preset manifests from `planned` to `ready` now that their source modules validate.
22+
3. Sharpened public positioning around the API SaaS wedge: API keys, usage tracking, rate limits, credits, Stripe billing, docs, and webhooks as editable source.
23+
4. Pointed module maintenance skills to installed shared provider, framework, database, SDK, and platform skills.
24+
5. Standardized provider adapter registry language and replaced legacy provider wording/paths.
25+
6. Renamed public command examples to `stackfoundry`.
26+
7. Updated `AGENTS.md` to match the current recipes, readiness, generated-output, and maintenance-skill model.
27+
8. Improved README badges, contribution controls, provider request templates, repo topics, and docs navigation for public discovery.
28+
9. Updated GitHub Actions dependencies for checkout, Node setup, pnpm setup, and dependency review.
2729

2830
### Security
2931

public/r/ai-saas.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"docs": "Installs the AI SaaS recipe from StackFoundry.",
4141
"meta": {
4242
"category": "recipe",
43-
"status": "planned",
43+
"status": "ready",
4444
"modules": [
4545
"drizzle-postgres",
4646
"api-keys",

public/r/arcjet-security.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"envVars": {
5252
"ARCJET_KEY": ""
5353
},
54-
"docs": "# Arcjet Security Module\n\nArcjet request protection starter for bot detection, shielding, and rate limits.\n\n## Owns\n\n- `apps/web/src/lib/arcjet.ts`\n- `apps/web/src/app/api/providers/arcjet/protected/route.ts`\n- `apps/web/src/app/(console)/admin/providers/arcjet/page.tsx`\n\n## Dependencies\n\n- `@arcjet/next`\n\n## Environment\n\n- `ARCJET_KEY`\n\n## Deployment Notes\n\n- Create the provider project/resource before deploying.\n- Add the listed environment variables to preview and production.\n- Smoke-test the included route or helper after deploy.\n- Keep provider secrets out of client components and logs.\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Update source examples when provider SDK APIs change.\n- Record production-specific retry, alerting, and rollback behavior before marking stable.\n",
54+
"docs": "# Arcjet Security Module\n\nArcjet request protection starter for bot detection, shielding, and rate limits.\n\n## Official Docs\n\n- [Arcjet Docs](https://docs.arcjet.com)\n\n## Owns\n\n- `apps/web/src/lib/arcjet.ts`\n- `apps/web/src/app/api/providers/arcjet/protected/route.ts`\n- `apps/web/src/app/(console)/admin/providers/arcjet/page.tsx`\n\n## Dependencies\n\n- `@arcjet/next`\n\n## Environment\n\n- `ARCJET_KEY`\n\n## Deployment Notes\n\n- Create the provider project/resource before deploying.\n- Add the listed environment variables to preview and production.\n- Smoke-test the included route or helper after deploy.\n- Keep provider secrets out of client components and logs.\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Update source examples when provider SDK APIs change.\n- Record production-specific retry, alerting, and rollback behavior before marking stable.\n",
5555
"meta": {
5656
"category": "security",
5757
"env": [

public/r/auth-better-auth.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
"BETTER_AUTH_SECRET": "",
5757
"BETTER_AUTH_URL": ""
5858
},
59-
"docs": "# Better Auth Module\n\nBetter Auth server config, Next.js route handler, and typed client starter.\n\n## Owns\n\n- `apps/web/src/lib/auth.ts`\n- `apps/web/src/lib/auth-client.ts`\n- `apps/web/src/app/api/auth/[...all]/route.ts`\n- `apps/web/src/app/(console)/admin/auth/better-auth/page.tsx`\n\n## Dependencies\n\n`better-auth`\n\n## Environment\n\n- `BETTER_AUTH_SECRET`\n- `BETTER_AUTH_URL`\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Keep secrets in environment variables and never commit local credentials.\n- Verify the example route or worker path before promoting this module beyond experimental.\n- Update docs, checklist, and manifest metadata when provider APIs change.\n",
59+
"docs": "# Better Auth Module\n\nBetter Auth server config, Next.js route handler, and typed client starter.\n\n## Official Docs\n\n- [Better Auth Docs](https://www.better-auth.com/docs)\n\n## Owns\n\n- `apps/web/src/lib/auth.ts`\n- `apps/web/src/lib/auth-client.ts`\n- `apps/web/src/app/api/auth/[...all]/route.ts`\n- `apps/web/src/app/(console)/admin/auth/better-auth/page.tsx`\n\n## Dependencies\n\n`better-auth`\n\n## Environment\n\n- `BETTER_AUTH_SECRET`\n- `BETTER_AUTH_URL`\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Keep secrets in environment variables and never commit local credentials.\n- Verify the example route or worker path before promoting this module beyond experimental.\n- Update docs, checklist, and manifest metadata when provider APIs change.\n",
6060
"meta": {
6161
"category": "auth",
6262
"env": [

public/r/autumn-billing.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
"envVars": {
4747
"AUTUMN_SECRET_KEY": ""
4848
},
49-
"docs": "# Autumn Billing\n\nOptional Autumn adapter for plan attach, checkout redirects, usage billing, overages, and plan changes.\n\nAutumn should sit beside the source-owned billing modules, not replace them by default. Use `billing-core` and `usage-metering` for local product state, then map plan ids and usage features into Autumn when the app chooses Autumn for hosted billing logic.\n\n## Owns\n\n- `apps/web/src/lib/autumn/billing.ts`\n- `apps/web/src/app/(console)/admin/providers/autumn-billing/page.tsx`\n\n## Dependencies\n\n- `autumn-js`\n- `registry:billing-core`\n- `registry:usage-metering`\n\n## Environment\n\n- `AUTUMN_SECRET_KEY`\n\n## Provider Notes\n\n- Autumn's `billing.attach` flow attaches a customer to a plan and may return a `paymentUrl` for hosted checkout.\n- Keep plan ids in server-owned configuration. Do not trust plan ids, prices, or feature quantities from client input without validation.\n- Model products, plans, usage features, included amounts, and overages in Autumn before promoting this adapter.\n\n## Maintenance\n\n- Keep this module focused on the Autumn boundary.\n- Update local billing mappings when Autumn product, plan, or feature ids change.\n- Verify sandbox checkout, upgrade, downgrade, saved-payment, and cancellation paths before marking stable.\n",
49+
"docs": "# Autumn Billing\n\nOptional Autumn adapter for plan attach, checkout redirects, usage billing, overages, and plan changes.\n\nAutumn should sit beside the source-owned billing modules, not replace them by default. Use `billing-core` and `usage-metering` for local product state, then map plan ids and usage features into Autumn when the app chooses Autumn for hosted billing logic.\n\n## Official Docs\n\n- [Autumn Docs](https://docs.useautumn.com)\n- [Autumn API Reference](https://docs.useautumn.com/api-reference)\n\n## Owns\n\n- `apps/web/src/lib/autumn/billing.ts`\n- `apps/web/src/app/(console)/admin/providers/autumn-billing/page.tsx`\n\n## Dependencies\n\n- `autumn-js`\n- `registry:billing-core`\n- `registry:usage-metering`\n\n## Environment\n\n- `AUTUMN_SECRET_KEY`\n\n## Provider Notes\n\n- Autumn's `billing.attach` flow attaches a customer to a plan and may return a `paymentUrl` for hosted checkout.\n- Keep plan ids in server-owned configuration. Do not trust plan ids, prices, or feature quantities from client input without validation.\n- Model products, plans, usage features, included amounts, and overages in Autumn before promoting this adapter.\n\n## Maintenance\n\n- Keep this module focused on the Autumn boundary.\n- Update local billing mappings when Autumn product, plan, or feature ids change.\n- Verify sandbox checkout, upgrade, downgrade, saved-payment, and cancellation paths before marking stable.\n",
5050
"meta": {
5151
"category": "billing",
5252
"env": [

public/r/autumn-entitlements.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
"envVars": {
4747
"AUTUMN_SECRET_KEY": ""
4848
},
49-
"docs": "# Autumn Entitlements\n\nOptional Autumn adapter for feature checks, metered usage, check-and-consume flows, credit balances, and upgrade context.\n\nAutumn should extend the source-owned entitlement and plan-gating modules. Keep local feature names, UI gates, and fallback behavior clear, then map them to Autumn feature ids when this provider is selected.\n\n## Owns\n\n- `apps/web/src/lib/autumn/entitlements.ts`\n- `apps/web/src/app/(console)/admin/providers/autumn-entitlements/page.tsx`\n\n## Dependencies\n\n- `autumn-js`\n- `registry:entitlements`\n- `registry:plan-gating`\n\n## Environment\n\n- `AUTUMN_SECRET_KEY`\n\n## Provider Notes\n\n- `check` returns whether a customer can use a feature. It supports required balances for metered features.\n- Use `sendEvent` only when you intentionally want check-and-consume behavior in one operation.\n- Use `track` after successful work for usage events, and include idempotency keys on retryable operations.\n- Usage-based pricing can allow overages even after included usage is consumed, so gates should handle the returned upgrade or balance context explicitly.\n\n## Maintenance\n\n- Keep feature ids, plan gates, and upgrade copy documented together.\n- Test boolean features, metered features, exhausted balances, overage paths, and idempotent retries before marking stable.\n- Keep provider secrets server-only.\n",
49+
"docs": "# Autumn Entitlements\n\nOptional Autumn adapter for feature checks, metered usage, check-and-consume flows, credit balances, and upgrade context.\n\nAutumn should extend the source-owned entitlement and plan-gating modules. Keep local feature names, UI gates, and fallback behavior clear, then map them to Autumn feature ids when this provider is selected.\n\n## Official Docs\n\n- [Autumn Docs](https://docs.useautumn.com)\n\n## Owns\n\n- `apps/web/src/lib/autumn/entitlements.ts`\n- `apps/web/src/app/(console)/admin/providers/autumn-entitlements/page.tsx`\n\n## Dependencies\n\n- `autumn-js`\n- `registry:entitlements`\n- `registry:plan-gating`\n\n## Environment\n\n- `AUTUMN_SECRET_KEY`\n\n## Provider Notes\n\n- `check` returns whether a customer can use a feature. It supports required balances for metered features.\n- Use `sendEvent` only when you intentionally want check-and-consume behavior in one operation.\n- Use `track` after successful work for usage events, and include idempotency keys on retryable operations.\n- Usage-based pricing can allow overages even after included usage is consumed, so gates should handle the returned upgrade or balance context explicitly.\n\n## Maintenance\n\n- Keep feature ids, plan gates, and upgrade copy documented together.\n- Test boolean features, metered features, exhausted balances, overage paths, and idempotent retries before marking stable.\n- Keep provider secrets server-only.\n",
5050
"meta": {
5151
"category": "billing",
5252
"env": [

public/r/axiom-logging.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"AXIOM_TOKEN": "",
5151
"AXIOM_DATASET": ""
5252
},
53-
"docs": "# Axiom Logging Module\n\nAxiom structured event logger and server route for deployment smoke checks.\n\n## Owns\n\n- `apps/web/src/lib/axiom/logger.ts`\n- `apps/web/src/app/api/providers/axiom/log/route.ts`\n- `apps/web/src/app/(console)/admin/providers/axiom/page.tsx`\n\n## Dependencies\n\n- `@axiomhq/js`\n\n## Environment\n\n- `AXIOM_TOKEN`\n- `AXIOM_DATASET`\n\n## Deployment Notes\n\n- Create the provider project/resource before deploying.\n- Add the listed environment variables to preview and production.\n- Smoke-test the included route or helper after deploy.\n- Keep provider secrets out of client components and logs.\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Update source examples when provider SDK APIs change.\n- Record production-specific retry, alerting, and rollback behavior before marking stable.\n",
53+
"docs": "# Axiom Logging Module\n\nAxiom structured event logger and server route for deployment smoke checks.\n\n## Official Docs\n\n- [Axiom Docs](https://axiom.co/docs)\n\n## Owns\n\n- `apps/web/src/lib/axiom/logger.ts`\n- `apps/web/src/app/api/providers/axiom/log/route.ts`\n- `apps/web/src/app/(console)/admin/providers/axiom/page.tsx`\n\n## Dependencies\n\n- `@axiomhq/js`\n\n## Environment\n\n- `AXIOM_TOKEN`\n- `AXIOM_DATASET`\n\n## Deployment Notes\n\n- Create the provider project/resource before deploying.\n- Add the listed environment variables to preview and production.\n- Smoke-test the included route or helper after deploy.\n- Keep provider secrets out of client components and logs.\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Update source examples when provider SDK APIs change.\n- Record production-specific retry, alerting, and rollback behavior before marking stable.\n",
5454
"meta": {
5555
"category": "observability",
5656
"env": [

public/r/b2b-saas.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
"docs": "Installs the B2B SaaS recipe from StackFoundry.",
100100
"meta": {
101101
"category": "recipe",
102-
"status": "planned",
102+
"status": "ready",
103103
"modules": [
104104
"drizzle-postgres",
105105
"api-keys",

public/r/clerk-auth.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
"CLERK_SECRET_KEY": "",
7070
"CLERK_WEBHOOK_SECRET": ""
7171
},
72-
"docs": "# Clerk Auth Module\n\nClerk sign-in/sign-up pages, middleware, server auth helper, and webhook starter.\n\n## Owns\n\n- `middleware.ts`\n- `apps/web/src/lib/clerk/authorization.ts`\n- `apps/web/src/app/(auth)/sign-in/[[...sign-in]]/page.tsx`\n- `apps/web/src/app/(auth)/sign-up/[[...sign-up]]/page.tsx`\n- `apps/web/src/app/api/webhooks/clerk/route.ts`\n- `apps/web/src/app/(console)/admin/auth/clerk/page.tsx`\n\n## Dependencies\n\n`@clerk/nextjs`\n\n## Environment\n\n- `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`\n- `CLERK_SECRET_KEY`\n- `CLERK_WEBHOOK_SECRET`\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Keep secrets in environment variables and never commit local credentials.\n- Verify the example route or worker path before promoting this module beyond experimental.\n- Update docs, checklist, and manifest metadata when provider APIs change.\n",
72+
"docs": "# Clerk Auth Module\n\nClerk sign-in/sign-up pages, middleware, server auth helper, and webhook starter.\n\n## Official Docs\n\n- [Clerk Docs](https://clerk.com/docs)\n- [Clerk Webhooks](https://clerk.com/docs/webhooks/sync-data)\n\n## Owns\n\n- `middleware.ts`\n- `apps/web/src/lib/clerk/authorization.ts`\n- `apps/web/src/app/(auth)/sign-in/[[...sign-in]]/page.tsx`\n- `apps/web/src/app/(auth)/sign-up/[[...sign-up]]/page.tsx`\n- `apps/web/src/app/api/webhooks/clerk/route.ts`\n- `apps/web/src/app/(console)/admin/auth/clerk/page.tsx`\n\n## Dependencies\n\n`@clerk/nextjs`\n\n## Environment\n\n- `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY`\n- `CLERK_SECRET_KEY`\n- `CLERK_WEBHOOK_SECRET`\n\n## Maintenance\n\n- Keep this module focused on the provider adapter boundary.\n- Keep secrets in environment variables and never commit local credentials.\n- Verify the example route or worker path before promoting this module beyond experimental.\n- Update docs, checklist, and manifest metadata when provider APIs change.\n",
7373
"meta": {
7474
"category": "auth",
7575
"env": [

0 commit comments

Comments
 (0)