django.md

Developer tools: documentation site using Django

Summary

A documentation site blueprint for developer tools built with Django on Ample. Domain schema includes:

Public information includes: versioned API reference and guides, SDK release notes, status page links. API keys and usage logs are secrets or personal data and should be kept out of documentation workflows. Technical basis verified on Django includes a workspace-scoped table and an explicit state machine.

Infrastructure requirements

Prerequisites

Steps

  1. Model the developer tools domain. Create the tables customer_workspaces, doc_versions, sdk_releases, customer_assets, state_transitions.
  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. Deploy. Run the synchronous deploy once and read the result.
    ample deploy . --name <app-name> --public --start "python3 run.py" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... --env CDN_PUBLIC_URL=...
    
  6. Verify. Run the pattern self-test(s) from the example (/p/relational-records).

Success checks

Cost estimate

Estimated 10.00 USD per month:

Always-on monthly price of the tested sizes; apps and databases auto-pause when idle.

Verification evidence