Skip to content

docs: add architecture and best-practices reference guides #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aseguragonzalez merged 4 commits into from
May 25, 2026
Merged

docs: add architecture and best-practices reference guides #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a24fc4
docs: add architecture and best-practices reference guides
aseguragonzalez May 24, 2026
376cf21
docs: align reference guides with actual seedwork API
aseguragonzalez May 25, 2026
aeb07f6
docs: fix sequence diagrams — validation precedes dispatch at API layer
aseguragonzalez May 25, 2026
1b94314
docs: add architecture and best-practices links to docs index
aseguragonzalez May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ This package provides DDD and Hexagonal Architecture building blocks for Python
- [Getting started](getting-started.md) — Step-by-step guide: install, define a domain model, handle commands, wire buses.
- [Component reference](component-reference.md) — Every abstract class, protocol, and infrastructure component.
- [Coding standards](coding-standards.md) — Conventions aligned with DDD and Clean Architecture, with do/don't guidelines.
- [Architecture](architecture.md) — Service building blocks: API, database, subscriber, publisher, worker, outbox, observability.
- [Best practices](best-practices.md) — Design rules for domain components, application layer contracts, and event/task selection.

## Complete working example

Expand Down
Loading
Loading