Skip to content

Commit 2f03259

Browse files
lesnik512claude
andauthored
docs: add 'The stack' narrative; stop publishing internal planning docs (#14)
Adds an equal-billing 'how it fits together' section to the org landing page (templates -> modern-di -> httpware -> faststream-outbox -> lite-bootstrap), with sharp per-project pitches in new prose. Also excludes docs/superpowers/ (strategy specs + plans) from the site build. Those files contain repo-relative links that broke 'mkdocs build --strict' — and therefore the Pages deploy — since they were added, and they are internal planning docs that shouldn't be public. Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 67d4102 commit 2f03259

2 files changed

Lines changed: 35 additions & 0 deletions

File tree

docs/index.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,40 @@ wires them together.
5454

5555
</div>
5656

57+
## The stack { #stack }
58+
59+
The modern-python projects fit together into one coherent stack for building
60+
production Python services. Use one piece or all of them — each is independent.
61+
62+
- **Start from a template.**
63+
[`fastapi-sqlalchemy-template`](https://github.com/modern-python/fastapi-sqlalchemy-template)
64+
and [`litestar-sqlalchemy-template`](https://github.com/modern-python/litestar-sqlalchemy-template)
65+
give you a dockerized, batteries-included app — FastAPI or Litestar,
66+
SQLAlchemy 2, PostgreSQL, with dependency injection already wired.
67+
- **Wire your dependencies** with
68+
[`modern-di`](https://github.com/modern-python/modern-di) — typed, scoped
69+
dependency injection with one wiring shared across FastAPI, Litestar,
70+
FastStream, and Typer.
71+
([`that-depends`](https://github.com/modern-python/that-depends), its
72+
production-proven predecessor, is still maintained.)
73+
- **Call other services reliably** with
74+
[`httpware`](https://github.com/modern-python/httpware) — an httpx-based client
75+
with typed errors, typed response bodies, and a composable resilience chain
76+
(retry, bulkhead, circuit breaker).
77+
- **Publish events reliably** with
78+
[`faststream-outbox`](https://github.com/modern-python/faststream-outbox) — the
79+
transactional outbox pattern for FastStream + PostgreSQL: write your domain row
80+
and outbox row in one transaction, relay to any broker with one decorator.
81+
- **Instrument everything** with
82+
[`lite-bootstrap`](https://github.com/modern-python/lite-bootstrap)
83+
OpenTelemetry, Prometheus, Sentry, and structlog wired into FastAPI, Litestar,
84+
or FastStream in a few lines.
85+
86+
Every project is built with the same tooling
87+
([`uv`](https://github.com/astral-sh/uv), [`ruff`](https://github.com/astral-sh/ruff),
88+
[`ty`](https://github.com/astral-sh/ty)) under the MIT license. Browse the full
89+
catalog below.
90+
5791
## Project templates { #templates }
5892

5993
- [`fastapi-sqlalchemy-template`](https://github.com/modern-python/fastapi-sqlalchemy-template) — dockerized web application with DI on FastAPI, SQLAlchemy 2, PostgreSQL.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ repo_name: modern-python
77
# Repo-internal docs that must not be published to the public site.
88
exclude_docs: |
99
DEPLOYMENT.md
10+
superpowers/
1011
1112
theme:
1213
name: material

0 commit comments

Comments
 (0)