Skip to content

Add developer guide explaining how NextAurora works #1

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
emeraldleaf merged 2 commits into from
May 9, 2026
Merged

Add developer guide explaining how NextAurora works #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd5759f
Initial plan
Copilot Mar 6, 2026
dd7a048
Add how-it-works developer guide and link all docs from README
Copilot Mar 6, 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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,16 @@ The project enforces code quality standards from day one:
| **gRPC (Sync)** | Protocol Buffers | Product validation during order placement |
| **REST (External)** | ASP.NET Core Minimal APIs | Frontend-to-service communication |

## Documentation

| Guide | Description |
|-------|-------------|
| [How It Works](docs/how-it-works.md) | Developer walkthrough — Clean Architecture, CQRS, request lifecycle, event flow, testing |
| [Architecture](docs/architecture.md) | Service diagrams, communication matrix, domain model, design patterns |
| [Observability](docs/observability.md) | Correlation IDs, distributed tracing, MediatR pipeline logging, DLQ handling, metrics |
| [Event Replay](docs/event-replay.md) | Event log, admin endpoints, debugging failed transactions, replay guide |
| [Business Requirements](docs/BRD.md) | Functional requirements, implementation status, business processes, glossary |

## License

This project is for educational and demonstration purposes.
Loading