Skip to content

Latest commit

 

History

History

README.md

DevCloud Documentation

This directory holds DevCloud's technical documentation. Use the map below to jump to what you need.

Start here

  • Getting Started — install, first run, boto3 / AWS CLI / Terraform examples
  • Configuration — YAML options, env-var overrides, tier shortcuts
  • Architecture — system design, plugin model, codegen pipeline, multi-CSP vision
  • Roadmap — phased plan toward multi-CSP support
  • Services Matrix — 104 services, coverage status, boto3 pass rate

What you can rely on

  • Compatibility Policy — what v1.0 guarantees across 1.x, what it explicitly does not, and how deprecation works
  • Fidelity Manifest — per-operation tiers: how much to trust any given call
  • CRUD Engine — how engine-served operations behave, and where they stop
  • Plugin API — the in-tree ServicePlugin contract for contributors

Per-service references

Located under services/:

  • S3 — object storage (REST-XML)
  • SQS — message queue (Query + JSON)
  • DynamoDB — NoSQL KV + document (JSON 1.0)
  • Lambda — function runtime (REST-JSON)
  • IAM / STS — identity & tokens (Query)

Problem solving

  • FAQ — common questions about scope, compatibility, CI use
  • Troubleshooting — common errors and fixes

Contributing

Meta


If something is missing from this index, that's a bug. Please file an issue or open a PR to fix the link.