Skip to content

Commit 423b16e

Browse files
committed
docs: add best practices documentation for Tux development
- Introduce comprehensive best practices across various aspects of Tux development, including async programming, error handling, logging, caching, CI/CD, code review, debugging, and documentation standards. - Enhance developer resources with structured guidelines to improve code quality, maintainability, and collaboration. - Update the index to reflect the new documentation structure and ensure easy navigation for contributors.
1 parent 79f0372 commit 423b16e

File tree

16 files changed

+4582
-564
lines changed

16 files changed

+4582
-564
lines changed

docs/content/developer/best-practices/async.md

Lines changed: 867 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Caching Best Practices
3+
---
4+
5+
Caching best practices for Tux development, including cache invalidation, cache expiration, and cache eviction.
6+
7+
Caching has not been implemented yet, so this section is placeholder. In the future, Redis or Valkey will be used for caching.
8+
9+
Some patterns of caching have been implemented across the codebase for smaller use cases but they are not yet properly documented.

0 commit comments

Comments
 (0)