Skip to content

Commit 9f258c1

Browse files
committed
docs(devdocs): Add generated dev documentation
Add AI generated dev documentation in the `docs` folder.
1 parent 683f644 commit 9f258c1

7 files changed

+2360
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ in the `go.mod` to `go 1.24` in one of the next releases.
4646

4747
- [English](https://redis.uptrace.dev)
4848
- [简体中文](https://redis.uptrace.dev/zh/)
49+
- [AI-Generated Developer Documentation](./docs) - Detailed technical documentation about the client's implementation, architecture, and internals
4950

5051
## Resources
5152

docs/README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Redis Client Documentation
2+
3+
This documentation is AI-generated and provides a comprehensive overview of the Redis client implementation. The documentation is organized into several key files, each focusing on different aspects of the Redis client.
4+
5+
## Documentation Structure
6+
7+
### 1. General Architecture ([`general_architecture.md`](general_architecture.md))
8+
- High-level architecture of the Redis client
9+
- Core components and their interactions
10+
- Connection management
11+
- Command processing pipeline
12+
- Error handling
13+
- Monitoring and instrumentation
14+
- Best practices and patterns
15+
16+
### 2. Connection Pool Implementation ([`redis_pool.md`](redis_pool.md))
17+
- Detailed explanation of the connection pool system
18+
- Pool configuration options
19+
- Connection lifecycle management
20+
- Pool statistics and monitoring
21+
- Error handling in the pool
22+
- Performance considerations
23+
- Best practices for pool usage
24+
25+
### 3. Command Processing ([`redis_command_processing.md`](redis_command_processing.md))
26+
- Command interface and implementation
27+
- Command execution pipeline
28+
- Different execution modes (single, pipeline, transaction)
29+
- Command types and categories
30+
- Error handling and retries
31+
- Best practices for command usage
32+
- Monitoring and debugging
33+
34+
### 4. Testing Framework ([`redis_testing.md`](redis_testing.md))
35+
- Test environment setup using Docker
36+
- Environment variables and configuration
37+
- Running tests with Makefile commands
38+
- Writing tests with Ginkgo and Gomega
39+
- Test organization and patterns
40+
- Coverage reporting
41+
- Best practices for testing
42+
43+
### 5. Clients and Connections ([`clients-and-connections.md`](clients-and-connections.md))
44+
- Detailed client types and their usage
45+
- Connection management and configuration
46+
- Client-specific features and optimizations
47+
- Connection pooling strategies
48+
- Best practices for client usage
49+
50+
## Important Notes
51+
52+
1. This documentation is AI-generated and should be reviewed for accuracy
53+
2. The documentation is based on the actual codebase implementation
54+
3. All examples and code snippets are verified against the source code
55+
4. The documentation is regularly updated to reflect changes in the codebase
56+
57+
## Contributing
58+
59+
For detailed information about contributing to the project, please see the [Contributing Guide](../CONTRIBUTING.md) in the root directory.
60+
61+
If you find any inaccuracies or would like to suggest improvements to the documentation, please:
62+
1. Review the actual code implementation
63+
2. Submit a pull request with the proposed changes
64+
3. Include references to the relevant code files
65+
66+
## Related Resources
67+
68+
- [Go Redis Client GitHub Repository](https://github.com/redis/go-redis)
69+
- [Redis Official Documentation](https://redis.io/documentation)
70+
- [Go Documentation](https://golang.org/doc/)

0 commit comments

Comments
 (0)