Skip to content

Commit 58267f8

Browse files
committed
Improved docs and added implementation details
1 parent 9f7250e commit 58267f8

26 files changed

Lines changed: 3146 additions & 1641 deletions

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ ILockProvider locker = new CacheLockProvider(cache, messageBus);
5454
await using var handle = await locker.AcquireAsync("resource-key");
5555
```
5656

57-
## 📦 Implementations
57+
## 📦 Provider Implementations
5858

5959
| Provider | Caching | Queues | Messaging | Storage | Locks |
6060
|----------|---------|--------|-----------|---------|-------|
@@ -73,12 +73,21 @@ await using var handle = await locker.AcquireAsync("resource-key");
7373

7474
**👉 [Complete Documentation](https://foundatio.dev)**
7575

76-
Key topics:
76+
### Core Features
7777

7878
- [Getting Started](https://foundatio.dev/guide/getting-started) - Installation and setup
79-
- [Caching](https://foundatio.dev/guide/caching) - Cache implementations and patterns
80-
- [Queues](https://foundatio.dev/guide/queues) - Message queue processing
81-
- [Jobs](https://foundatio.dev/guide/jobs) - Background job execution
79+
- [Caching](https://foundatio.dev/guide/caching) - In-memory, Redis, and hybrid caching with invalidation
80+
- [Queues](https://foundatio.dev/guide/queues) - FIFO message delivery with lock renewal and retry policies
81+
- [Locks](https://foundatio.dev/guide/locks) - Distributed locking with null handling patterns
82+
- [Messaging](https://foundatio.dev/guide/messaging) - Pub/sub with size limits and notification patterns
83+
- [File Storage](https://foundatio.dev/guide/storage) - Unified file API across providers
84+
- [Jobs](https://foundatio.dev/guide/jobs) - Background job processing and hosted service integration
85+
86+
### Advanced Topics
87+
88+
- [Resilience](https://foundatio.dev/guide/resilience) - Retry policies, circuit breakers, and timeouts
89+
- [Serialization](https://foundatio.dev/guide/serialization) - Serializer configuration and performance
90+
- [Dependency Injection](https://foundatio.dev/guide/dependency-injection) - DI setup and patterns
8291
- [Configuration](https://foundatio.dev/guide/configuration) - Options and settings
8392

8493
## 📦 CI Packages (Feedz)

docs/.vitepress/config.ts

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ export default defineConfig({
1414
})
1515
]
1616
},
17-
mermaid: {
18-
// Mermaid configuration
19-
},
2017
head: [
2118
['link', { rel: 'icon', href: 'https://raw.githubusercontent.com/FoundatioFx/Foundatio/main/media/foundatio-icon.png', type: 'image/png' }],
2219
['meta', { name: 'theme-color', content: '#3c8772' }]
@@ -56,24 +53,35 @@ export default defineConfig({
5653
{
5754
text: 'Advanced Topics',
5855
items: [
59-
{ text: 'Resilience', link: '/guide/resilience' },
56+
{ text: 'Configuration', link: '/guide/configuration' },
6057
{ text: 'Dependency Injection', link: '/guide/dependency-injection' },
61-
{ text: 'Configuration', link: '/guide/configuration' }
58+
{ text: 'Resilience', link: '/guide/resilience' },
59+
{ text: 'Serialization', link: '/guide/serialization' }
6260
]
6361
},
6462
{
6563
text: 'Implementations',
6664
items: [
65+
{ text: 'Aliyun', link: '/guide/implementations/aliyun' },
66+
{ text: 'AWS', link: '/guide/implementations/aws' },
67+
{ text: 'Azure', link: '/guide/implementations/azure' },
68+
{ text: 'Hybrid Cache', link: '/guide/implementations/hybrid-cache' },
6769
{ text: 'In-Memory', link: '/guide/implementations/in-memory' },
70+
{ text: 'Kafka', link: '/guide/implementations/kafka' },
71+
{ text: 'Minio', link: '/guide/implementations/minio' },
72+
{ text: 'RabbitMQ', link: '/guide/implementations/rabbitmq' },
6873
{ text: 'Redis', link: '/guide/implementations/redis' },
69-
{ text: 'Azure', link: '/guide/implementations/azure' },
70-
{ text: 'AWS', link: '/guide/implementations/aws' }
74+
{ text: 'SshNet', link: '/guide/implementations/sshnet' }
7175
]
7276
},
7377
{
7478
text: 'Related Projects',
7579
items: [
76-
{ text: 'Foundatio.Mediator', link: 'https://mediator.foundatio.dev' }
80+
{ text: 'Foundatio.CommandQuery', link: 'https://github.com/FoundatioFx/Foundatio.CommandQuery' },
81+
{ text: 'Foundatio.Lucene', link: 'https://lucene.foundatio.dev' },
82+
{ text: 'Foundatio.Mediator', link: 'https://mediator.foundatio.dev' },
83+
{ text: 'Foundatio.Parsers', link: 'https://github.com/FoundatioFx/Foundatio.Parsers' },
84+
{ text: 'Foundatio.Repositories', link: 'https://github.com/FoundatioFx/Foundatio.Repositories' }
7785
]
7886
}
7987
]

docs/README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ npm run docs:preview
4545

4646
## Project Structure
4747

48-
```
48+
```txt
4949
docs/
5050
├── .vitepress/
5151
│ ├── config.ts # VitePress configuration
@@ -79,11 +79,13 @@ docs/
7979

8080
1. Create a new `.md` file in the appropriate directory
8181
2. Add frontmatter with title:
82+
8283
```yaml
8384
---
8485
title: Your Page Title
8586
---
8687
```
88+
8789
3. Add the page to the sidebar in `.vitepress/config.ts`
8890

8991
### Code Blocks
@@ -135,14 +137,19 @@ This documentation site uses:
135137
- **vitepress-plugin-llms**: Generates LLM-friendly documentation at `/llms.txt`
136138
- **vitepress-plugin-mermaid**: Enables Mermaid diagrams in markdown
137139

138-
### Mermaid Diagrams
140+
### Diagrams
141+
142+
The documentation uses diagrams for visual explanations:
139143

140144
```markdown
141-
```mermaid
142-
graph LR
143-
A[Client] --> B[Cache]
144-
B --> C[Redis]
145-
```
145+
​```txt
146+
┌─────────┐ ┌──────────────┐ ┌──────────────┐
147+
│ Request │────▶│ Local Cache │────▶│ Redis Cache │
148+
└─────────┘ └──────────────┘ └──────────────┘
149+
│ │
150+
▼ ▼
151+
Cache Hit? Cache Hit?
152+
​```
146153
```
147154

148155
## Deployment
@@ -163,6 +170,7 @@ The documentation can be deployed to any static hosting service:
163170
### Netlify / Vercel
164171

165172
Connect your repository and configure:
173+
166174
- Build command: `npm run docs:build`
167175
- Output directory: `.vitepress/dist`
168176

0 commit comments

Comments
 (0)