Skip to content

Commit 6faa8df

Browse files
committed
docs: Reorder and update documentation guides in TOC and README, and refine API endpoint description.
1 parent 39ad980 commit 6faa8df

2 files changed

Lines changed: 32 additions & 29 deletions

File tree

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,20 +134,23 @@ BookStore/
134134

135135
- **[Getting Started](docs/getting-started.md)** - Setup and first steps
136136
- **[Architecture Overview](docs/architecture.md)** - System design and patterns
137+
- **[Event Sourcing Guide](docs/event-sourcing-guide.md)** - Event sourcing concepts and implementation
137138
- **[Aspire Orchestration Guide](docs/aspire-guide.md)** - Service orchestration and local development
138-
- **[Aspire Deployment Guide](docs/aspire-deployment-guide.md)** - Deploy to Azure and Kubernetes
139-
- **[Production Scaling Guide](docs/production-scaling-guide.md)** - Scale applications and databases in production
140-
- **[Configuration Guide](docs/configuration-guide.md)** - Options pattern and validation
141-
- **[Performance Guide](docs/performance-guide.md)** - GC optimization and performance tuning
142-
- **[Logging Guide](docs/logging-guide.md)** - Structured logging with source-generated log messages
143-
- **[Testing Guide](docs/testing-guide.md)** - Testing with TUnit, assertions, and best practices
139+
- **[Marten Guide](docs/marten-guide.md)** - Document DB and Event Store features
144140
- **[Wolverine Integration](docs/wolverine-guide.md)** - Command/handler pattern with Wolverine
141+
- **[Configuration Guide](docs/configuration-guide.md)** - Options pattern and validation
145142
- **[API Conventions](docs/api-conventions-guide.md)** - Time handling and JSON serialization standards
146143
- **[API Client Generation](docs/api-client-generation.md)** - Automated client generation with OpenAPI and Refitter
147-
- **[ETag Support](docs/etag-guide.md)** - Optimistic concurrency and caching
144+
- **[Real-time Notifications](docs/signalr-guide.md)** - SignalR integration and optimistic updates
145+
- **[Logging Guide](docs/logging-guide.md)** - Structured logging with source-generated log messages
148146
- **[Correlation & Causation IDs](docs/correlation-causation-guide.md)** - Distributed tracing
147+
- **[Localization Guide](docs/localization-guide.md)** - Multi-language support
149148
- **[Caching Guide](docs/caching-guide.md)** - Hybrid caching with Redis and localization support
150-
- **[Real-time Notifications](docs/signalr-guide.md)** - SignalR integration and optimistic updates
149+
- **[ETag Support](docs/etag-guide.md)** - Optimistic concurrency and caching
150+
- **[Performance Guide](docs/performance-guide.md)** - GC optimization and performance tuning
151+
- **[Testing Guide](docs/testing-guide.md)** - Testing with TUnit, assertions, and best practices
152+
- **[Aspire Deployment Guide](docs/aspire-deployment-guide.md)** - Deploy to Azure and Kubernetes
153+
- **[Production Scaling Guide](docs/production-scaling-guide.md)** - Scale applications and databases in production
151154
- **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute to this project
152155

153156
## 🔧 Technology Stack
@@ -181,7 +184,7 @@ BookStore/
181184

182185
### Public Endpoints
183186

184-
- `GET /api/books/search` - Search books with pagination
187+
- `GET /api/books` - List and search books (search with `?search=query`)
185188
- `GET /api/books/{id}` - Get book by ID (with ETag)
186189
- `GET /api/authors` - List authors
187190
- `GET /api/categories` - List categories (localized)

docs/toc.yml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,40 @@
44
href: architecture.md
55
- name: Guides
66
items:
7+
- name: Event Sourcing
8+
href: event-sourcing-guide.md
9+
- name: Aspire Orchestration
10+
href: aspire-guide.md
711
- name: Marten
812
href: marten-guide.md
913
- name: Wolverine
1014
href: wolverine-guide.md
15+
- name: Configuration
16+
href: configuration-guide.md
17+
- name: API Conventions
18+
href: api-conventions-guide.md
19+
- name: API Client Generation
20+
href: api-client-generation.md
1121
- name: SignalR
1222
href: signalr-guide.md
13-
- name: Event Sourcing
14-
href: event-sourcing-guide.md
15-
- name: Testing
16-
href: testing-guide.md
17-
- name: Performance
18-
href: performance-guide.md
19-
- name: Localization
20-
href: localization-guide.md
2123
- name: Logging
2224
href: logging-guide.md
23-
- name: ETag
24-
href: etag-guide.md
25-
- name: Caching
26-
href: caching-guide.md
2725
- name: Correlation & Causation
2826
href: correlation-causation-guide.md
29-
- name: API Conventions
30-
href: api-conventions-guide.md
31-
- name: API Client Generation
32-
href: api-client-generation.md
33-
- name: Aspire Orchestration
34-
href: aspire-guide.md
27+
- name: Localization
28+
href: localization-guide.md
29+
- name: Caching
30+
href: caching-guide.md
31+
- name: ETag
32+
href: etag-guide.md
33+
- name: Performance
34+
href: performance-guide.md
35+
- name: Testing
36+
href: testing-guide.md
3537
- name: Aspire Deployment
3638
href: aspire-deployment-guide.md
3739
- name: Production Scaling
3840
href: production-scaling-guide.md
39-
- name: Configuration
40-
href: configuration-guide.md
4141
- name: Rules
4242
items:
4343
- name: Analyzer Rules

0 commit comments

Comments
 (0)