Skip to content

Commit e44e2e6

Browse files
kzndotshkzndotsh
committed
docs: enhance best practices documentation and update mkdocs configuration
- Add detailed descriptions to various best practices documents, improving clarity and guidance for Tux development. - Update mkdocs.yml to include task list support and modify page title usage for better navigation. - Revise SUMMARY.md to include new best practices topics, ensuring comprehensive coverage of development guidelines.
1 parent 423b16e commit e44e2e6

File tree

13 files changed

+50
-19
lines changed

13 files changed

+50
-19
lines changed

‎docs/content/SUMMARY.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,17 @@ title: Summary
5656
* [Tasks](developer/concepts/tasks/index.md)
5757
* developer/concepts/tasks/*.md
5858
* [Best Practices](developer/best-practices/index.md)
59-
* developer/best-practices/*.md
59+
* [Git](developer/best-practices/git.md)
60+
* [CI/CD](developer/best-practices/ci-cd.md)
61+
* [Async Patterns](developer/best-practices/async.md)
62+
* [Error Handling](developer/best-practices/error-handling.md)
63+
* [Logging](developer/best-practices/logging.md)
64+
* [Caching](developer/best-practices/caching.md)
65+
* [Code Review](developer/best-practices/code-review.md)
66+
* [Debugging](developer/best-practices/debugging.md)
67+
* [Documentation](developer/best-practices/docs.md)
68+
* [Testing](developer/best-practices/testing/index.md)
69+
* developer/best-practices/testing/*.md
6070
* [Reference](reference/index.md)
6171
* [API Reference](reference/src/tux/)
6272
* [CLI Reference](reference/cli.md)

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Async Best Practices
3+
description: Async programming best practices for Tux development, including concurrency patterns, Discord.py async considerations, and performance optimization.
34
---
45

5-
Async programming best practices for Tux development, including concurrency patterns, Discord.py async considerations, and performance optimization.
6-
76
## Why Async Matters for Discord Bots
87

98
Discord bots operate in a highly concurrent environment where thousands of users can interact simultaneously. Traditional synchronous programming would create blocking operations that make the bot unresponsive.

‎docs/content/developer/best-practices/caching.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
title: Caching Best Practices
3+
description: Caching best practices for Tux development, including cache invalidation, cache expiration, and cache eviction.
34
---
45

5-
Caching best practices for Tux development, including cache invalidation, cache expiration, and cache eviction.
6+
## Coming Soon
67

78
Caching has not been implemented yet, so this section is placeholder. In the future, Redis or Valkey will be used for caching.
89

‎docs/content/developer/best-practices/ci-cd.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: CI/CD Best Practices
3+
description: CI/CD best practices for Tux development, including pipeline architecture, change detection strategy, and quality assurance.
34
---
45

5-
Comprehensive CI/CD best practices for Tux development, covering continuous integration, automated testing, security scanning, containerization, and deployment strategies.
6-
76
## Overview
87

98
Tux uses GitHub Actions for a comprehensive CI/CD pipeline that ensures code quality, security, and reliable deployments. The pipeline includes:

‎docs/content/developer/best-practices/code-review.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Code Review Best Practices
3+
description: Code review best practices for Tux development, including effective review techniques, common patterns, and collaboration guidelines.
34
---
45

5-
Code review best practices for Tux development, including effective review techniques, common patterns, and collaboration guidelines.
6-
76
## Why Code Reviews Matter
87

98
Code reviews are essential for maintaining code quality, catching bugs early, sharing knowledge, and ensuring consistency across the Tux codebase.

‎docs/content/developer/best-practices/debugging.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Debugging Best Practices
3+
description: Debugging best practices for Tux development, including logging, interactive debugging, testing, and common debugging scenarios.
34
---
45

5-
Debugging best practices for Tux development, including logging, interactive debugging, testing, and common debugging scenarios.
6-
76
## Development Setup
87

98
### Debug Mode

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Documentation Best Practices
3+
description: Documentation best practices for Tux development, including writing standards, structure guidelines, and quality assurance processes.
34
---
45

5-
Documentation best practices for Tux development, including writing standards, structure guidelines, and quality assurance processes.
6-
76
## Core Principles
87

98
### User-Centric Approach

‎docs/content/developer/best-practices/error-handling.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Error Handling Best Practices
3+
description: Error handling best practices for Tux development, including exception patterns, graceful degradation, and debugging techniques.
34
---
45

5-
Error handling best practices for Tux development, including exception patterns, graceful degradation, and debugging techniques.
6-
76
## Tux Exception Hierarchy
87

98
All Tux-specific exceptions inherit from `TuxError` base class for consistent error handling:

‎docs/content/developer/best-practices/git.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Git Best Practices
3+
description: Git best practices for Tux development, including branching strategy, commit conventions, and workflow automation.
34
---
45

5-
Git best practices for Tux development, including branching strategy, commit conventions, and workflow automation.
6-
76
## Contributing Workflows
87

98
Tux is an open source project that supports contributions from both organization members and external contributors. The workflow differs slightly based on your access level.

‎docs/content/developer/best-practices/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Best Practices
3+
description: Best practices for Tux development, including architecture, design, testing, code review, debugging, documentation, and CI/CD.
34
---
45

56
# Best Practices

0 commit comments

Comments
 (0)