-
-
Notifications
You must be signed in to change notification settings - Fork 41
v0.1.0rc5 #1020
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
src/tux/database/migrations/versions/2025_08_19_0437-12574673e637_initial_baseline_migration.py
Outdated
Show resolved
Hide resolved
src/tux/database/migrations/versions/2025_08_19_0437-12574673e637_initial_baseline_migration.py
Outdated
Show resolved
Hide resolved
src/tux/database/migrations/versions/2025_08_19_0437-12574673e637_initial_baseline_migration.py
Outdated
Show resolved
Hide resolved
src/tux/database/migrations/versions/2025_08_19_0437-12574673e637_initial_baseline_migration.py
Outdated
Show resolved
Hide resolved
src/tux/database/migrations/versions/2025_08_19_0437-12574673e637_initial_baseline_migration.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
markdownlint
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 8. Security"]
| ### 8. Security |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Database credentials man..."]
| - [ ] Database credentials management |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 9. Performance & Monitoring"]
| ### 9. Performance & Monitoring |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Query performance monito..."]
| - [ ] Query performance monitoring |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 10. Production Readiness"]
| ### 10. Production Readiness |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Backup and recovery proc..."]
| - [ ] Backup and recovery procedures |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 11. Error Handling & Resilience"]
| ### 11. Error Handling & Resilience |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Database connection fail..."]
| - [ ] Database connection failure handling |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 12. Documentation & Maintenance"]
| ### 12. Documentation & Maintenance |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Database schema document..."]
| - [ ] Database schema documentation |
[markdownlint] reported by reviewdog 🐶
MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Overall Assessment: 🟢 GOOD FO..."]
| **Overall Assessment: 🟢 GOOD FOUNDATION with some IMPORTANT improvements needed** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Database accessible from any..."]
| - Database accessible from any network interface |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```conf"]
| ```conf |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Dictionary attacks possible"]
| - Dictionary attacks possible |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Use strong, randomly generat..."]
| - Use strong, randomly generated passwords (32+ characters) |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```python"]
| ```python |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- May overwhelm database in hi..."]
| - May overwhelm database in high-traffic scenarios |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Exponential backoff for conn..."]
| - Exponential backoff for connection retries |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Slow query log analysis"]
| - Slow query log analysis |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Automated backup scripts"]
| - Automated backup scripts |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### ✅ Architecture: Clean Separation"]
| ### ✅ **Architecture: Clean Separation** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Unit tests (py-pglite) vs In..."]
| - Unit tests (py-pglite) vs Integration tests (Docker) perfectly separated |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### ✅ Configuration: Smart Environment Handling"]
| ### ✅ **Configuration: Smart Environment Handling** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Automatic URL construction f..."]
| - Automatic URL construction from individual variables |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### ✅ Performance: Good Connection Pooling"]
| ### ✅ **Performance: Good Connection Pooling** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Reasonable pool sizes for de..."]
| - Reasonable pool sizes for development |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### ✅ Testing: Excellent Test Infrastructure"]
| ### ✅ **Testing: Excellent Test Infrastructure** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- py-pglite for fast unit test..."]
| - py-pglite for fast unit tests (10-100x faster) |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### ✅ Migrations: Well-Configured Alembic"]
| ### ✅ **Migrations: Well-Configured Alembic** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Proper sync/async URL conver..."]
| - Proper sync/async URL conversion |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Phase 1: Security (Week 1)"]
| ### **Phase 1: Security (Week 1)** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. 🔴 Fix PostgreSQL listen_ad..."]
| 1. 🔴 Fix PostgreSQL listen_addresses (docker/postgres/postgresql.conf) |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Phase 2: Reliability (Week 2)"]
| ### **Phase 2: Reliability (Week 2)** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. 🟡 Implement circuit breake..."]
| 1. 🟡 Implement circuit breaker pattern |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Phase 3: Operations (Week 3)"]
| ### **Phase 3: Operations (Week 3)** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. 🟡 Set up automated backups"]
| 1. 🟡 Set up automated backups |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Phase 4: Optimization (Ongoing)"]
| ### **Phase 4: Optimization (Ongoing)** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. ℹ️ Performance tuning based..."]
| 1. ℹ️ Performance tuning based on metrics |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Current State: 🟢 GOOD for Development"]
| ### **Current State: 🟢 GOOD for Development** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Excellent testing infrastruc..."]
| - Excellent testing infrastructure |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Production Readiness: 🟡 NEEDS IMPORTANT FIXES"]
| ### **Production Readiness: 🟡 NEEDS IMPORTANT FIXES** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **Security issues must be re..."]
| - **Security issues must be resolved** before any public deployment |
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
| ``` |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. Delete the migration file"]
tux/docs/content/db/database-lifecycle.md
Line 79 in 0cb9e17
| 1. Delete the migration file |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- The baseline migration estab..."]
tux/docs/content/db/database-lifecycle.md
Line 156 in 0cb9e17
| - The baseline migration establishes Alembic's version tracking |
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
tux/docs/content/db/database-lifecycle.md
Line 162 in 0cb9e17
| ``` |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-lifecycle.md
Line 224 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-lifecycle.md
Line 244 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-lifecycle.md
Line 260 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
tux/docs/content/db/database-lifecycle.md
Line 281 in 0cb9e17
| ``` |
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
tux/docs/content/db/database-lifecycle.md
Line 281 in 0cb9e17
| ``` |
[markdownlint] reported by reviewdog 🐶
MD013/line-length Line length [Expected: 100; Actual: 108]
tux/docs/content/db/database-lifecycle.md
Line 291 in 0cb9e17
| **Symptoms**: `alembic revision --autogenerate -m "baseline"` creates a migration with `def upgrade(): pass` |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-lifecycle.md
Line 311 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Package name: Install `p..."]
tux/docs/content/db/database-lifecycle.md
Line 380 in 0cb9e17
| - **Package name**: Install `psycopg[binary]` (not `psycopg3`) |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Use options string instead..."]
tux/docs/content/db/database-lifecycle.md
Line 427 in 0cb9e17
| - Use `options` string instead of `server_settings` dict |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```python"]
tux/docs/content/db/database-lifecycle.md
Line 434 in 0cb9e17
| ```python |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-lifecycle.md
Line 446 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```python"]
tux/docs/content/db/database-lifecycle.md
Line 455 in 0cb9e17
| ```python |
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
tux/docs/content/db/database-lifecycle.md
Line 515 in 0cb9e17
| ``` |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Contributors can safely ..."]
tux/docs/content/db/database-lifecycle.md
Line 524 in 0cb9e17
| - **Contributors** can safely develop and test database changes |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- All commands should complete..."]
tux/docs/content/db/database-lifecycle.md
Line 569 in 0cb9e17
| - All commands should complete without errors |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Current PostgreSQL settings"]
| - Current PostgreSQL settings |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
| ``` |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Most settings are managed au..."]
tux/docs/content/db/database-optimization.md
Line 134 in 0cb9e17
| - Most settings are managed automatically |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 📅 Daily Tasks:"]
tux/docs/content/db/database-optimization.md
Line 140 in 0cb9e17
| ### **📅 Daily Tasks:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 141 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 📅 Weekly Tasks:"]
tux/docs/content/db/database-optimization.md
Line 149 in 0cb9e17
| ### **📅 Weekly Tasks:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 150 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 📅 Monthly Tasks:"]
tux/docs/content/db/database-optimization.md
Line 158 in 0cb9e17
| ### **📅 Monthly Tasks:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 159 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 📅 As Needed:"]
tux/docs/content/db/database-optimization.md
Line 167 in 0cb9e17
| ### **📅 As Needed:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 168 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 📊 Health Monitoring:"]
tux/docs/content/db/database-optimization.md
Line 181 in 0cb9e17
| ### **📊 Health Monitoring:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 182 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 🔧 Maintenance Operations:"]
tux/docs/content/db/database-optimization.md
Line 193 in 0cb9e17
| ### **🔧 Maintenance Operations:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 194 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 📋 Information and Analysis:"]
tux/docs/content/db/database-optimization.md
Line 205 in 0cb9e17
| ### **📋 Information and Analysis:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 206 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Problem: Slow Queries"]
tux/docs/content/db/database-optimization.md
Line 245 in 0cb9e17
| ### **Problem: Slow Queries** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 246 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Problem: High Memory Usage"]
tux/docs/content/db/database-optimization.md
Line 257 in 0cb9e17
| ### **Problem: High Memory Usage** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 258 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Problem: Tables Not Being Maintained"]
tux/docs/content/db/database-optimization.md
Line 266 in 0cb9e17
| ### **Problem: Tables Not Being Maintained** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 267 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Problem: Indexes Not Being Used"]
tux/docs/content/db/database-optimization.md
Line 275 in 0cb9e17
| ### **Problem: Indexes Not Being Used** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
tux/docs/content/db/database-optimization.md
Line 276 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Connection Pooling:"]
tux/docs/content/db/database-optimization.md
Line 286 in 0cb9e17
| ### **Connection Pooling:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```ini"]
tux/docs/content/db/database-optimization.md
Line 288 in 0cb9e17
| ```ini |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Partitioning:"]
tux/docs/content/db/database-optimization.md
Line 299 in 0cb9e17
| ### **Partitioning:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```sql"]
tux/docs/content/db/database-optimization.md
Line 301 in 0cb9e17
| ```sql |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Parallel Query Processing:"]
tux/docs/content/db/database-optimization.md
Line 312 in 0cb9e17
| ### **Parallel Query Processing:** |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```ini"]
tux/docs/content/db/database-optimization.md
Line 314 in 0cb9e17
| ```ini |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### PostgreSQL Documentation:"]
tux/docs/content/db/database-optimization.md
Line 324 in 0cb9e17
| ### **PostgreSQL Documentation:** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [Performance Tuning](https:/..."]
tux/docs/content/db/database-optimization.md
Line 325 in 0cb9e17
| - [Performance Tuning](https://www.postgresql.org/docs/current/runtime-config-query.html) |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Tux-Specific Commands:"]
tux/docs/content/db/database-optimization.md
Line 329 in 0cb9e17
| ### **Tux-Specific Commands:** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- make help-db - List all da..."]
tux/docs/content/db/database-optimization.md
Line 330 in 0cb9e17
| - `make help-db` - List all database commands |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### External Tools:"]
tux/docs/content/db/database-optimization.md
Line 334 in 0cb9e17
| ### **External Tools:** |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- pgAdmin - GUI database a..."]
tux/docs/content/db/database-optimization.md
Line 335 in 0cb9e17
| - **pgAdmin** - GUI database administration |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Prerequisites"]
| ### Prerequisites |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Fresh system/VM with no ..."]
| - [ ] Fresh system/VM with no previous Tux installation |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1. Environment Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 18 in 0cb9e17
| ### 1. Environment Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Install uv: `curl -LsS..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 19 in 0cb9e17
| - [ ] Install `uv`: `curl -LsSf https://astral.sh/uv/install.sh | sh` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 2. Repository Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 23 in 0cb9e17
| ### 2. Repository Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] `git clone https://githu..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 24 in 0cb9e17
| - [ ] `git clone https://github.com/allthingslinux/tux.git` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 3. Configuration Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 28 in 0cb9e17
| ### 3. Configuration Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] cp env.example .env"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 29 in 0cb9e17
| - [ ] `cp env.example .env` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 4. Dependencies & Environment"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 37 in 0cb9e17
| ### 4. Dependencies & Environment |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] uv sync"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 38 in 0cb9e17
| - [ ] `uv sync` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 5. Database Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 43 in 0cb9e17
| ### 5. Database Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Ensure PostgreSQL is run..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 44 in 0cb9e17
| - [ ] Ensure PostgreSQL is running (or SQLite file is writable) |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 6. Bot Startup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 50 in 0cb9e17
| ### 6. Bot Startup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] make dev or `make star..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 51 in 0cb9e17
| - [ ] `make dev` or `make start` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 7. Feature Testing"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 56 in 0cb9e17
| ### 7. Feature Testing |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Test basic commands: `!h..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 57 in 0cb9e17
| - [ ] Test basic commands: `!help`, `!ping` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 8. New Server Scenario Testing"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 64 in 0cb9e17
| ### 8. New Server Scenario Testing |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Test bot joining new ser..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 65 in 0cb9e17
| - [ ] Test bot joining new server (if possible) |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1. Environment Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 75 in 0cb9e17
| ### 1. Environment Setup |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### 1. Environment Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 75 in 0cb9e17
| ### 1. Environment Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Install Docker & Docker ..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 76 in 0cb9e17
| - [ ] Install Docker & Docker Compose v2 |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 2. Repository Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 80 in 0cb9e17
| ### 2. Repository Setup |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### 2. Repository Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 80 in 0cb9e17
| ### 2. Repository Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] `git clone https://githu..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 81 in 0cb9e17
| - [ ] `git clone https://github.com/allthingslinux/tux.git` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 3. Configuration Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 85 in 0cb9e17
| ### 3. Configuration Setup |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### 3. Configuration Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 85 in 0cb9e17
| ### 3. Configuration Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] cp env.example .env"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 86 in 0cb9e17
| - [ ] `cp env.example .env` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 4. Docker Startup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 92 in 0cb9e17
| ### 4. Docker Startup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] make docker-dev or `ma..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 93 in 0cb9e17
| - [ ] `make docker-dev` or `make prod` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 5. Testing"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 100 in 0cb9e17
| ### 5. Testing |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Check logs: `docker comp..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 101 in 0cb9e17
| - [ ] Check logs: `docker compose logs -f` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 1. Environment Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 109 in 0cb9e17
| ### 1. Environment Setup |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### 1. Environment Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 109 in 0cb9e17
| ### 1. Environment Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Install Docker & Docker ..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 110 in 0cb9e17
| - [ ] Install Docker & Docker Compose v2 |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 2. Repository Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 114 in 0cb9e17
| ### 2. Repository Setup |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### 2. Repository Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 114 in 0cb9e17
| ### 2. Repository Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] `git clone https://githu..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 115 in 0cb9e17
| - [ ] `git clone https://github.com/allthingslinux/tux.git` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 3. Configuration Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 120 in 0cb9e17
| ### 3. Configuration Setup |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### 3. Configuration Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 120 in 0cb9e17
| ### 3. Configuration Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] cp env.example .env"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 121 in 0cb9e17
| - [ ] `cp env.example .env` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 4. Docker Production Startup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 128 in 0cb9e17
| ### 4. Docker Production Startup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] make docker-prod or `m..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 129 in 0cb9e17
| - [ ] `make docker-prod` or `make prod` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### 5. Production Verification"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 136 in 0cb9e17
| ### 5. Production Verification |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Check logs: `docker comp..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 137 in 0cb9e17
| - [ ] Check logs: `docker compose logs -f` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Environment Variables"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 147 in 0cb9e17
| ### Environment Variables |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] ENV variable works cor..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 148 in 0cb9e17
| - [ ] `ENV` variable works correctly (dev/prod/test) |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Bot Configuration"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 153 in 0cb9e17
| ### Bot Configuration |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Bot name and version dis..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 154 in 0cb9e17
| - [ ] Bot name and version display correctly |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Database Configuration"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 159 in 0cb9e17
| ### Database Configuration |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Connection established s..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 160 in 0cb9e17
| - [ ] Connection established successfully |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Local Development"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 172 in 0cb9e17
| ### Local Development |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Stop bot: Ctrl+C"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 173 in 0cb9e17
| - [ ] Stop bot: `Ctrl+C` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Docker Development"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 178 in 0cb9e17
| ### Docker Development |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Stop containers: `docker..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 179 in 0cb9e17
| - [ ] Stop containers: `docker compose down` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Production"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 184 in 0cb9e17
| ### Production |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Stop containers: `docker..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 185 in 0cb9e17
| - [ ] Stop containers: `docker compose down` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Python/UV Issues"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 194 in 0cb9e17
| ### Python/UV Issues |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem: `uv: command no..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 195 in 0cb9e17
| - **Problem**: `uv: command not found` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Database Issues"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 201 in 0cb9e17
| ### Database Issues |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem: Migration failu..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 202 in 0cb9e17
| - **Problem**: Migration failures during startup |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Database Issues"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 211 in 0cb9e17
| ### Database Issues |
[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### Database Issues"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 211 in 0cb9e17
| ### Database Issues |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem: Connection refu..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 212 in 0cb9e17
| - **Problem**: Connection refused |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Docker Issues"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 218 in 0cb9e17
| ### Docker Issues |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem: Port conflicts"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 219 in 0cb9e17
| - **Problem**: Port conflicts |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Bot Issues"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 225 in 0cb9e17
| ### Bot Issues |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Problem: Bot doesn't con..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 226 in 0cb9e17
| - **Problem**: Bot doesn't connect |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Developer Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 236 in 0cb9e17
| ### Developer Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Bot connects to Discord ..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 237 in 0cb9e17
| - [ ] Bot connects to Discord successfully |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Production Setup"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 243 in 0cb9e17
| ### Production Setup |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Bot runs in production m..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 244 in 0cb9e17
| - [ ] Bot runs in production mode |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### All Setups"]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 250 in 0cb9e17
| ### All Setups |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- [ ] Configuration loads with..."]
tux/docs/content/SETUP_TEST_CHECKLIST.md
Line 251 in 0cb9e17
| - [ ] Configuration loads without errors |
[markdownlint] reported by reviewdog 🐶
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
tux/docs/content/SETUP_TESTING.md
Line 33 in 0cb9e17
| ``` |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### All Tests Pass (6/6)"]
tux/docs/content/SETUP_TESTING.md
Line 166 in 0cb9e17
| ### All Tests Pass (6/6) |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Configuration loads correctl..."]
tux/docs/content/SETUP_TESTING.md
Line 168 in 0cb9e17
| - Configuration loads correctly |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Some Tests Fail (1-5/6)"]
tux/docs/content/SETUP_TESTING.md
Line 173 in 0cb9e17
| ### Some Tests Fail (1-5/6) |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Check the specific failing t..."]
tux/docs/content/SETUP_TESTING.md
Line 175 in 0cb9e17
| - Check the specific failing tests |
[markdownlint] reported by reviewdog 🐶
MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### All Tests Fail (0/6)"]
tux/docs/content/SETUP_TESTING.md
Line 180 in 0cb9e17
| ### All Tests Fail (0/6) |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Verify Python environment"]
tux/docs/content/SETUP_TESTING.md
Line 182 in 0cb9e17
| - Verify Python environment |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 10 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 17 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 23 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 34 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 40 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 46 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Automatic migrations: Bo..."]
Line 163 in 0cb9e17
| - **Automatic migrations**: Bot runs migrations automatically on startup in production |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 212 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 217 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 222 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 231 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 237 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 243 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 260 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 266 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 271 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 282 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 287 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 292 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 301 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 308 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 315 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 100 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 106 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 111 in 0cb9e17
| ```bash |
[markdownlint] reported by reviewdog 🐶
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
Line 117 in 0cb9e17
| ```bash |
- Revise the Bot Features section to include detailed descriptions of core architecture, advanced features, user experience, and extensibility. - Introduce new sections for Plugin System and Database Features, outlining architecture, development guidelines, and type-safe operations. - Improve overall documentation structure for better clarity and user navigation.
- Consolidate and simplify the Bot Features section, focusing on key functionalities and user experience. - Revise Plugin System and Database Features sections for clarity and conciseness, emphasizing modularity and type-safe operations. - Improve overall documentation structure for better navigation and accessibility.
- Revise the license section to correct the phrasing regarding the founding and maintenance of the project, ensuring accurate representation of contributions and community involvement.
- Introduce a new section on namespace packages and the __all__ declaration in the best practices documentation. - Provide detailed explanations, examples, and best practices for organizing Python packages and defining public APIs. - Enhance the overall developer guidance for maintaining clean and extensible APIs in the Tux codebase.
- Revise the Application Layer, Bot Core, and Lifecycle Orchestration sections to enhance clarity and conciseness. - Introduce new documentation for the Base Cog, Cog Loader, and Plugin System, providing detailed explanations and usage examples. - Remove outdated Cog System and Command System documentation to streamline content and improve navigation. - Update the index to reflect the new structure and ensure easy access to core concepts for developers.
- Delete obsolete guides on Adding Features, Config Options, Creating a Cog, Database Operations, and UI Components to streamline documentation. - Introduce a new guide for Components V2, detailing the modern component system in Discord.py with practical examples and constraints. - Update the index to reflect the removal of outdated guides and ensure easy navigation for developers.
- Add front matter to the first contribution tutorial for better metadata management. - Revise the tutorials index to include a title and description, enhancing clarity and organization. - Update the UI Components Walkthrough tutorial to link to the new Components V2 guide for advanced patterns.
- Wrap content in a new div for better layout management. - Adjust CSS to improve the order of elements, ensuring the title appears before the description. - Update styles for the content wrapper to utilize flexbox for improved responsiveness.
- Add RUF022 to the ignore list in pyproject.toml for unsorted dunder-all. - Simplify error messages in tux.py by removing unnecessary emojis for better readability. - Update type hints in app.py to avoid circular import issues. - Refactor base_cog.py to use the shared generate_usage function directly. - Enhance error logging in setup services to avoid duplicate messages. - Organize __all__ declarations across various modules for better clarity and structure.
- Replace the Developer Guide with a new Developer Index for improved navigation and organization. - Add a new section on Namespace under Best Practices in the SUMMARY.md for better guidance on package organization. - Reinstate the Versioning section in the Reference index for clarity on version management.
…ing, and error handling - Revise the async best practices section to enhance clarity on concurrency patterns and performance optimization for Discord bots. - Update caching best practices to provide a placeholder for future implementation details and document existing patterns. - Streamline the error handling best practices section, emphasizing Tux's exception hierarchy and strategies for user, infrastructure, and system errors. - Improve overall structure and readability across all best practices documents for better developer guidance.
- Remove the pyupgrade hook from the pre-commit configuration to streamline the setup. - Retain other hooks for code quality checks, ensuring continued adherence to coding standards.
- Delete the deploy.yml file as it was a placeholder template requiring configuration. - This change streamlines the workflow directory by removing unused files.
- Add front matter to the "Creating Your First Cog" and "Creating Your First Command" tutorials for better metadata management. - Introduce a new "Getting Started for Admins" guide with a focus on installation, configuration, and usage. - Streamline the content in existing tutorials to improve clarity and organization, with placeholders for upcoming content.
- Add instructions for installing pre-commit hooks in the README for developer convenience. - Update package versions in uv.lock for several dependencies, including annotated-doc, backrefs, griffe, mkdocs-material, mkdocstrings-python, pydantic-settings, pynacl, pytest-asyncio, sentry-sdk, and types-psutil to their latest releases, ensuring compatibility and access to new features.
…ments - Expanded the CHANGELOG to include detailed descriptions of new features, improvements, and fixes across various systems including core infrastructure, database, permission, configuration, moderation, utility commands, and more. - Organized entries into clear categories for better readability and navigation, reflecting significant changes such as the migration to SQLModel, the introduction of a modular configuration system, and enhancements to error handling and logging. - Removed outdated entries and streamlined the structure to align with the latest project developments.
- Add headings to the bug report and feature request templates for improved clarity and organization. - Enhance the structure of the templates to better guide users in providing detailed reports and suggestions.
…up instructions - Added sections for contributing workflows tailored to organization members and external contributors, clarifying the process for each. - Expanded development setup instructions, including environment variable configuration and database initialization steps. - Introduced a branching strategy and commit message guidelines to standardize contributions and improve collaboration. - Updated links to the Tux documentation site for comprehensive guidance.
- Added additional spacing in the pull request template to enhance readability. - Maintained the structure while ensuring clear instructions for summarizing changes, listing dependencies, and addressing issues.
- Removed deprecated ignoreDeps section and added enabledManagers for better clarity. - Expanded auto-merge rules for development, testing, documentation, and type stubs, improving automation for dependency updates. - Introduced a new lock file maintenance rule for the pep621 manager. - Updated Python version constraints to ensure compatibility with future releases.
- Changed the vulnerability reporting email from `[email protected]` to `[email protected]` for improved communication. - Removed outdated note regarding email server compatibility with Outlook.
- Added the renovate-config-validator hook to validate Renovate configuration files. - Expanded the Renovate configuration with new rules for auto-merging various dependency types, including dev, test, documentation, and type stubs. - Introduced additional settings for managing GitHub Actions and Docker updates, improving automation and organization of dependency updates. - Updated timezone and dependency dashboard settings for better visibility and management of unresolved vulnerabilities.
- Changed the `cwd` for the build command from `.` to `docs` to ensure the correct directory is used during the build process.
- Changed the background color in the social cards layout from '#11111B' to '#181825' for improved visual consistency.
…ommands - Changed the assets directory from "../data/build/docs" to "./site" to align with MkDocs output. - Added important notes regarding Workers Builds deployment commands for production and non-production environments. - Updated comments to clarify that build configuration is now managed in the Cloudflare Dashboard instead of within the wrangler.toml file.
- Changed asset paths in mkdocs.yml to remove leading './' for consistency. - Updated comments in wrangler.toml to reflect changes in deployment URL structure and added smart placement configuration for improved performance.
- Updated site_url in mkdocs.yml to include a trailing slash for consistency. - Reformatted asset paths in mkdocs.yml and wrangler.toml for improved readability. - Added workers_dev configuration in wrangler.toml to enable preview URLs on workers.dev subdomains.
- Added a period to the site_description in mkdocs.yml for grammatical accuracy. - Changed text-rendering property in material.css from optimizeSpeed to optimizeLegibility for improved font rendering. - Introduced font-optical-sizing in material.css to enhance typography.
… and listings - Added a new 'Listings' page to the reference section for better organization of content. - Updated mkdocs.yml to include new footer links and adjusted existing links for consistency. - Removed outdated 'Search' and 'Snippet Search' pages to streamline the documentation. - Enhanced the styling for dynamically inserted code in material.css to improve syntax highlighting. - Updated paths in SUMMARY.md to ensure all links are relative and consistent.
@sourcery-ai summary