Skip to content

Commit 49c3949

Browse files
author
Вадим Козыревский
committed
Refactor documentation css
1 parent 92390f2 commit 49c3949

4 files changed

Lines changed: 899 additions & 322 deletions

File tree

docs/index.md

Lines changed: 31 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,25 @@
3030

3131
Quick project setup and configuration with automatic DI container setup.
3232

33-
[:octicons-arrow-right-24: Get Started](bootstrap/index.md)
33+
[:octicons-arrow-right-24: Read More](bootstrap/index.md)
3434

3535
- :material-code-tags: **Request Handlers**
3636

3737
Handle commands and queries with full type safety and async support.
3838

39-
[:octicons-arrow-right-24: Learn More](request_handler.md)
39+
[:octicons-arrow-right-24: Read More](request_handler.md)
4040

4141
- :material-sync: **Saga Pattern**
4242

4343
Orchestrated Saga for distributed transactions with automatic compensation.
4444

45-
[:octicons-arrow-right-24: Explore](saga/index.md)
45+
[:octicons-arrow-right-24: Read More](saga/index.md)
4646

4747
- :material-bell-ring: **Event Handling**
4848

4949
Process domain events with parallel processing and runtime execution.
5050

51-
[:octicons-arrow-right-24: Discover](event_handler/index.md)
51+
[:octicons-arrow-right-24: Read More](event_handler/index.md)
5252

5353
- :material-database-outline: **Transaction Outbox**
5454

@@ -60,19 +60,25 @@
6060

6161
Sequential request processing with flexible handler chaining.
6262

63-
[:octicons-arrow-right-24: See Details](chain_of_responsibility/index.md)
63+
[:octicons-arrow-right-24: Read More](chain_of_responsibility/index.md)
6464

6565
- :material-play-circle: **Streaming**
6666

6767
Incremental processing with real-time progress updates via SSE.
6868

69-
[:octicons-arrow-right-24: Learn More](stream_handling/index.md)
69+
[:octicons-arrow-right-24: Read More](stream_handling/index.md)
7070

7171
- :material-puzzle: **Integrations**
7272

7373
FastAPI, FastStream, Kafka, and Protobuf integrations out of the box.
7474

75-
[:octicons-arrow-right-24: View Integrations](fastapi.md)
75+
[:octicons-arrow-right-24: Read More](fastapi.md)
76+
77+
- :material-graph: **Mermaid Diagrams**
78+
79+
Visualize architecture patterns and flows with interactive Mermaid diagrams.
80+
81+
[:octicons-arrow-right-24: Read More](mermaid/index.md)
7682

7783
</div>
7884

@@ -92,12 +98,29 @@
9298

9399
---
94100

95-
## Quick Start
101+
## Installation
102+
103+
Install Python CQRS using pip or uv:
104+
105+
**Using pip:**
96106

97107
```bash
98108
pip install python-cqrs
99109
```
100110

111+
**Using uv:**
112+
113+
```bash
114+
uv pip install python-cqrs
115+
```
116+
117+
!!! info "Requirements"
118+
Python 3.8+ • Pydantic v2
119+
120+
---
121+
122+
## Quick Start
123+
101124
```python
102125
import di
103126
import cqrs
@@ -127,47 +150,3 @@ result = await mediator.send(CreateUserCommand(email="user@example.com", name="J
127150
```
128151

129152
See [Bootstrap](bootstrap/index.md) for detailed setup instructions.
130-
131-
---
132-
133-
## Architecture
134-
135-
**Request****RequestHandler****Event****EventHandler**
136-
137-
Commands and queries flow through handlers, which execute business logic and emit events. Events are automatically dispatched to event handlers for side effects processing.
138-
139-
---
140-
141-
## Installation
142-
143-
```bash
144-
pip install python-cqrs
145-
```
146-
147-
!!! info "Requirements"
148-
Python 3.8+ • Pydantic v2
149-
150-
---
151-
152-
## Documentation
153-
154-
Explore the comprehensive documentation to learn more about each feature:
155-
156-
- **[Bootstrap](bootstrap/index.md)** — Quick project setup and configuration
157-
- **[Request Handlers](request_handler.md)** — Working with commands and queries
158-
- **[Saga Pattern](saga/index.md)** — Distributed transactions with automatic compensation
159-
- **[Event Handling](event_handler/index.md)** — Processing domain events
160-
- **[Transaction Outbox](outbox/index.md)** — Reliable event delivery
161-
- **[Stream Handling](stream_handling/index.md)** — Incremental processing with streaming
162-
- **[Chain of Responsibility](chain_of_responsibility/index.md)** — Sequential request processing
163-
- **[Integrations](fastapi.md)** — FastAPI, FastStream, Kafka, Protobuf
164-
165-
---
166-
167-
## About
168-
169-
This framework is developed by the **Timeweb.Cloud** development team.
170-
171-
<div class="company-info">
172-
<p>Built with ❤️ by <a href="https://timeweb.cloud/" target="_blank" rel="noopener">Timeweb.Cloud</a> — your reliable cloud infrastructure partner.</p>
173-
</div>

0 commit comments

Comments
 (0)