Skip to content

Commit 55a19c0

Browse files
committed
feat(markdownlint): enhance markdownlint configuration and update commands in documentation
- Added new rules MD058 (blanks around tables), MD059 (descriptive link text), and MD060 (table column style) to the markdownlint configuration for improved markdown quality. - Updated the pre-commit configuration to use the markdownlint-fix hook for automatic formatting. - Introduced a new section in AGENTS.md for configuration commands, providing users with clear instructions for generating and validating configuration files. - Removed the Quick Commands section from README.md to streamline the documentation and avoid redundancy.
1 parent 57345bf commit 55a19c0

File tree

5 files changed

+21
-49
lines changed

5 files changed

+21
-49
lines changed

.markdownlint.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,3 +223,15 @@ MD055:
223223
style: consistent
224224
# MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
225225
MD056: true
226+
# MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md058.md
227+
MD058: true
228+
# MD059/descriptive-link-text : Link text should be descriptive : https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md059.md
229+
MD059:
230+
# Prohibited link texts
231+
prohibited_texts:
232+
- click here
233+
- here
234+
- link
235+
- more
236+
# MD060/table-column-style : Table column style : https://github.com/DavidAnson/markdownlint/blob/v0.39.0/doc/md060.md
237+
MD060: false

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ repos:
3939
- repo: https://github.com/igorshubovych/markdownlint-cli
4040
rev: v0.46.0
4141
hooks:
42-
- id: markdownlint
42+
- id: markdownlint-fix
4343
- repo: https://github.com/asottile/add-trailing-comma
4444
rev: v4.0.0
4545
hooks:

.vscode/settings.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@
5555
"files.trimTrailingWhitespace": false,
5656
"editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
5757
},
58-
"markdownlint.config": {
59-
"extends": ".markdownlint.yaml"
60-
},
61-
"markdownlint.run": "onType",
58+
"markdownlint.configFile": ".markdownlint.yaml",
6259
"[json]": {
6360
"editor.defaultFormatter": "vscode.json-language-features"
6461
},

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,13 @@ uv run docs build # Build site
9898
uv run docs deploy # Deploy to GitHub Pages
9999
```
100100

101+
**Configuration:**
102+
103+
```bash
104+
uv run config generate # Generate configuration example files
105+
uv run config validate # Validate the current configuration
106+
```
107+
101108
## Development Workflow
102109

103110
1. **Setup:** `uv sync` → configure `.env` & `config.toml`

README.md

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@ It is designed to provide a variety of features to the server, including moderat
5858
- [Prerequisites](#prerequisites)
5959
- [Setup & Workflow](#setup--workflow)
6060
- [Documentation & Support](#documentation--support)
61-
- [Quick Commands](#quick-commands)
6261
- [License](#license)
6362
- [Metrics](#metrics)
6463
- [Contributors](#contributors)
@@ -188,49 +187,6 @@ Modular plugin architecture for extending functionality without modifying core c
188187

189188
<sub>[back to top ↑](#table-of-contents)</sub>
190189

191-
## Quick Commands
192-
193-
| Category | Command | Description |
194-
|----------|---------|-------------|
195-
| **Bot** | `uv run tux start` | Start the Tux Discord bot |
196-
| | `uv run tux version` | Show Tux version information |
197-
| **Development** | `uv run dev lint` | Run linting with Ruff |
198-
| | `uv run dev lint-fix` | Run linting with Ruff and apply fixes |
199-
| | `uv run dev format` | Format code with Ruff |
200-
| | `uv run dev type-check` | Check types with basedpyright |
201-
| | `uv run dev lint-docstring` | Lint docstrings with pydoclint |
202-
| | `uv run dev docstring-coverage` | Check docstring coverage |
203-
| | `uv run dev pre-commit` | Run pre-commit checks |
204-
| | `uv run dev all` | Run all development checks |
205-
| **Testing** | `uv run tests all` | Run all tests with coverage and enhanced output |
206-
| | `uv run tests quick` | Run tests without coverage (faster) |
207-
| | `uv run tests plain` | Run tests with plain output |
208-
| | `uv run tests parallel` | Run tests in parallel |
209-
| | `uv run tests html` | Run tests and generate HTML report |
210-
| | `uv run tests coverage` | Generate comprehensive coverage reports |
211-
| | `uv run tests benchmark` | Run benchmark tests |
212-
| **Database** | `uv run db init` | Initialize database with proper migrations |
213-
| | `uv run db dev` | Development workflow: generate migration and apply it |
214-
| | `uv run db push` | Apply all pending migrations to database |
215-
| | `uv run db status` | Show current migration status |
216-
| | `uv run db new "message"` | Generate new migration from model changes |
217-
| | `uv run db health` | Check database connection health |
218-
| | `uv run db schema` | Validate database schema matches models |
219-
| | `uv run db queries` | Check for long-running queries |
220-
| **Docker** | `uv run docker up` | Start Docker services with smart orchestration |
221-
| | `uv run docker down` | Stop Docker services |
222-
| | `uv run docker build` | Build Docker images |
223-
| | `uv run docker logs` | Show Docker service logs |
224-
| | `uv run docker ps` | List running Docker containers |
225-
| | `uv run docker shell` | Open shell in container |
226-
| | `uv run docker health` | Check container health status |
227-
| | `uv run docker config` | Validate Docker Compose configuration |
228-
| **Documentation** | `uv run docs serve` | Start local documentation server |
229-
| | `uv run docs build` | Build documentation site |
230-
| **Configuration** | `uv run config generate` | Generate example configuration files |
231-
232-
<sub>[back to top ↑](#table-of-contents)</sub>
233-
234190
## License
235191

236192
Tux is free and open source software licensed under the [GNU General Public License v3.0](LICENSE), founded by [@kzndotsh](https://github.com/kzndotsh), created for and maintained by the [All Things Linux](https://allthingslinux.org) community.

0 commit comments

Comments
 (0)