page:blueprints:developer tools:documentation site:next js

Developer Tools: Documentation Site Using Next.js

Summary

A documentation site blueprint for developer tools built with Next.js on Ample. Domain schema:

• customer_workspaces (name, plan, api_key_count): customer organizations;
• doc_versions (product_version, title, object_key, published_at): versioned reference docs and guides;
• sdk_releases (language, version, changelog_object_key, released_at): SDK releases and changelogs;
• customer_assets (workspace_id, title, object_key, visibility): customer-specific artifacts;
• state_transitions (record_type, from_state, to_state): the allowed state machine.

Public information includes versioned API reference and guides, SDK release notes, and status page links.

Workflow Steps

1. Model the developer tools domain: Create the tables customer_workspaces, doc_versions, sdk_releases, customer_assets, state_transitions. Keep sensitive classes out of the schema.
2. Workflow step 1: Model versioned documents with a state machine (draft, review, published) scoped to a product version.
3. Workflow step 2: Publish assets for released versions to the CDN bucket.
4. Workflow step 3: Serve only published versions publicly.
5. Workflow step 4: Deploy and verify the version list and a published page.
6. Deploy: Run ample deploy . --name --public --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... --env CDN_PUBLIC_URL=... to deploy once and check the result.
7. Verify: Run the pattern self-test(s) from the example (/p/relational-records) and your own acceptance checks for the developer tools workflow.

Technical Basis

Verified on Next.js: a workspace-scoped table, a state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing.

Limitation

• Sensitive information should remain out of documentation workflows.
• The documentation and workflow are an original design for this blueprint and were not executed as a separate application.

Cost Estimate

• Currency: USD
• Monthly Amount: 10.0
  • App server (size: s-1vcpu-1gb): $5.00
  • Managed PostgreSQL database (size: s-1vcpu-1gb): $5.00

Success Checks

• The app responds on its public URL.
• Self-test for relational records should pass.

Next Actions

• Browse the catalog index
• Search published recipes by intent, stack, and constraints
• Prepare a side-effect-free deployment plan for an authorized project
• Read the existing agent authentication setup
• Browse Developer tools, Documentation site, and Next.js catalogs