📝 docs(mkdocs): add mise equivalent commands along with make

Author: bassemkaroui

README.md

@@ -135,27 +135,39 @@ uvx copier update --trust --exclude src/ --exclude tests/ .
 All tasks are defined in `mise.toml` and exposed through `make`. Common tasks include:
 
 ```
+audit                      Check dependencies for known vulnerabilities.
 build                      Build source and wheel distributions.
-check                      Check it all!
-docs-check                 Check if the documentation builds correctly.
+check-all                  Run all quality checks.
 check-quality              Run linters and format checks.
+check-security             Run security analysis with Bandit.
 check-types                Run static type checks.
 clean-all                  Delete build artifacts.
 clean-cache                Remove cache files.
 coverage                   Generate coverage reports (text, HTML, XML).
+dc                         Run docker compose with Doppler-mounted .env.
 docker-build               Build Docker images.
+docker-shell               Open a shell in a service container.
 docker-start               Start Docker Compose services.
 docker-stop                Stop and remove Docker Compose services.
-docs-serve                 Serve the documentation (localhost:8080).
+docs-check                 Check if the documentation builds correctly.
 docs-deploy                Publish docs to GitHub Pages.
+docs-serve                 Serve the documentation (localhost:8080).
+doppler-create-config      Create a new Doppler branch config.
+doppler-create-token       Create a Doppler service token for this directory.
+doppler-delete-config      Delete a Doppler branch config.
+doppler-set-token          Configure a preexisting Doppler service token.
+doppler-upload-secrets     Upload a local .env file to Doppler.
 format                     Auto-format code (Ruff).
+mise-setup-completions     Install mise shell completions for the current shell.
+pre-commit                 Run all pre-commit hooks on all files.
 publish                    Upload distributions to PyPI.
 release                    Automate version bump, changelog, and publish.
-setup                      Bootstrap prod environment.
 setup-cli                  Install the project's CLI globally via uv.
 setup-dev                  Bootstrap dev environment & install pre-commit hooks.
+setup-prod                 Set up the project environment.
 test                       Run tests with pytest.
 tox                        Run tests across multiple Python versions.
+upgrade                    Upgrade all dependencies to latest compatible versions.
 ```
 
 For the full list and details, see [mise.toml](https://github.com/bassemkaroui/python-template-uv/blob/main/template/mise.toml.jinja).

copier.yaml

@@ -23,7 +23,7 @@ _tasks:
     echo '  ACTION REQUIRED: Set up the following repo secrets' &&
     echo '========================================================' &&
     echo '' &&
-    echo '  - GIPHY_API_KEY  : needed for PR thank-you comments' &&
+    echo '  - GIPHY_API_KEY           : needed for PR thank-you comments' &&
     {% if dependency_updater == 'renovate' and renovate_auth_method == 'pat' %}
     echo '  - RENOVATE_TOKEN          : needed for self-hosted Renovate' &&
     {% elif dependency_updater == 'renovate' and renovate_auth_method == 'github_app' %}

docs/features/ci-cd.md

@@ -41,10 +41,10 @@ GitHub-native solution. Opens weekly PRs to keep GitHub Actions dependencies up
 
 ## Required Secrets
 
-| Secret | Required For | How to Set |
-|--------|-------------|------------|
-| `GIPHY_API_KEY` | PR thank-you comments | `gh secret set GIPHY_API_KEY` |
-| `PYPI_TOKEN` | PyPI publishing (if enabled) | `gh secret set PYPI_TOKEN` |
-| `RENOVATE_TOKEN` | Renovate with PAT auth | `gh secret set RENOVATE_TOKEN` |
-| `RENOVATE_APP_ID` | Renovate with GitHub App auth | `gh secret set RENOVATE_APP_ID` |
-| `RENOVATE_APP_PRIVATE_KEY` | Renovate with GitHub App auth | `gh secret set RENOVATE_APP_PRIVATE_KEY` |
+| Secret                     | Required For                  | How to Set                                                         |
+| -------------------------- | ----------------------------- | ------------------------------------------------------------------ |
+| `GIPHY_API_KEY`            | PR thank-you comments         | `gh secret set GIPHY_API_KEY`                                      |
+| `PYPI_TOKEN`               | PyPI publishing (if enabled)  | `gh secret set PYPI_TOKEN`                                         |
+| `RENOVATE_TOKEN`           | Renovate with PAT auth        | `gh secret set RENOVATE_TOKEN`                                     |
+| `RENOVATE_APP_ID`          | Renovate with GitHub App auth | `gh secret set RENOVATE_APP_ID`                                    |
+| `RENOVATE_APP_PRIVATE_KEY` | Renovate with GitHub App auth | `gh secret set RENOVATE_APP_PRIVATE_KEY < path/to/private-key.pem` |

docs/features/docker.md

@@ -12,6 +12,8 @@ When `dockerfile: true` (the default), the template generates Docker configurati
 
 ## Commands
 
+/// tab | make
+
 ```bash
 # Build Docker images
 make docker-build
@@ -23,6 +25,23 @@ make docker-start
 make docker-stop
 ```
 
+///
+
+/// tab | mise
+
+```bash
+# Build Docker images
+mise run docker:build
+
+# Start services
+mise run docker:start
+
+# Stop and remove services
+mise run docker:stop
+```
+
+///
+
 ## GPU Support
 
 Enable GPU support by setting `gpus: true` during generation. This adds NVIDIA GPU configuration to the Docker setup:

docs/features/documentation.md

@@ -11,6 +11,8 @@ Generated projects include a fully configured [MkDocs](https://github.com/mkdocs
 
 ## Local Development
 
+/// tab | make
+
 ```bash
 # Serve docs with live reload (localhost:8080)
 make docs-serve
@@ -19,13 +21,40 @@ make docs-serve
 make docs-check
 ```
 
+///
+
+/// tab | mise
+
+```bash
+# Serve docs with live reload (localhost:8080)
+mise run docs:serve
+
+# Check that docs build without errors
+mise run docs:check
+```
+
+///
+
 ## Deployment
 
+/// tab | make
+
 ```bash
 # Deploy to GitHub Pages
 make docs-deploy
 ```
 
+///
+
+/// tab | mise
+
+```bash
+# Deploy to GitHub Pages
+mise run docs:deploy
+```
+
+///
+
 The CI/CD pipeline also deploys docs automatically on pushes to `main`.
 
 ## Structure

docs/features/optional.md

@@ -10,11 +10,24 @@ Scaffolds a [Typer](https://typer.tiangolo.com/) CLI application with:
 - CLI module with a sample command
 - Customizable CLI name via the `cli_name` variable
 
+/// tab | make
+
 ```bash
 # Install CLI globally after generation
 make setup-cli
 ```
 
+///
+
+/// tab | mise
+
+```bash
+# Install CLI globally after generation
+mise run setup:cli
+```
+
+///
+
 ## Strict Typing (`with_strict_typing`)
 
 Enables strict type checking and adds a `py.typed` marker file for [PEP 561](https://peps.python.org/pep-0561/) compliance. This signals to downstream consumers that your package ships inline type information.

docs/features/quality-tools.md

@@ -6,6 +6,8 @@ The template sets up a comprehensive code quality pipeline that runs automatical
 
 [Ruff](https://github.com/astral-sh/ruff) handles both **formatting** and **linting** in a single, fast tool.
 
+/// tab | make
+
 ```bash
 # Auto-format code
 make format
@@ -14,16 +16,42 @@ make format
 make check-quality
 ```
 
+///
+
+/// tab | mise
+
+```bash
+# Auto-format code
+mise run format
+
+# Check formatting and lint rules
+mise run check:quality
+```
+
+///
+
 Ruff is configured in `pyproject.toml` with sensible defaults. It replaces Black, isort, flake8, and many other tools.
 
 ## Mypy
 
 [Mypy](https://github.com/python/mypy) performs static type checking.
 
+/// tab | make
+
 ```bash
 make check-types
 ```
 
+///
+
+/// tab | mise
+
+```bash
+mise run check:types
+```
+
+///
+
 Configuration lives in `pyproject.toml`. If you enable the `with_strict_typing` option during generation, a `py.typed` marker file is included for PEP 561 compliance.
 
 ## Pre-commit Hooks
@@ -46,7 +74,20 @@ pre-commit install
 
 ## Running All Checks
 
+/// tab | make
+
+```bash
+# Run everything: lint, types, docs build
+make check-all
+```
+
+///
+
+/// tab | mise
+
 ```bash
 # Run everything: lint, types, docs build
-make check
+mise run check:all
 ```
+
+///

docs/features/task-runner.md

@@ -10,30 +10,48 @@ make <task>
 mise run <task>
 ```
 
+> [!TIP]
+> Prefer `mise run` over `make` when running tasks directly:
+>
+> - **Auto-completion**: Run `make mise-setup-completions` to install shell completions for mise, giving you tab-completion for all tasks.
+> - **Flags & arguments**: mise tasks can accept flags and positional arguments (e.g. `mise run docker-build --dev`, `mise run test -- -k test_foo`), which is not possible through `make`.
+
 ## Available Tasks
 
-| Task | Description |
-|------|-------------|
-| `build` | Build source and wheel distributions |
-| `check` | Run all checks (lint, types, docs) |
-| `check-quality` | Run linters and format checks |
-| `check-types` | Run static type checks |
-| `clean-all` | Delete build artifacts |
-| `clean-cache` | Remove cache files |
-| `coverage` | Generate coverage reports (text, HTML, XML) |
-| `docker-build` | Build Docker images |
-| `docker-start` | Start Docker Compose services |
-| `docker-stop` | Stop and remove Docker Compose services |
-| `docs-serve` | Serve the documentation (localhost:8080) |
-| `docs-deploy` | Publish docs to GitHub Pages |
-| `docs-check` | Check if the documentation builds correctly |
-| `format` | Auto-format code (Ruff) |
-| `publish` | Upload distributions to PyPI |
-| `release` | Automate version bump, changelog, and publish |
-| `setup` | Bootstrap prod environment |
-| `setup-cli` | Install the project's CLI globally via uv |
-| `setup-dev` | Bootstrap dev environment and install pre-commit hooks |
-| `test` | Run tests with pytest |
-| `tox` | Run tests across multiple Python versions |
+| Task                     | Description                                            |
+| ------------------------ | ------------------------------------------------------ |
+| `audit`                  | Check dependencies for known vulnerabilities           |
+| `build`                  | Build source and wheel distributions                   |
+| `check-all`              | Run all quality checks                                 |
+| `check-quality`          | Run linters and format checks                          |
+| `check-security`         | Run security analysis with Bandit                      |
+| `check-types`            | Run static type checks                                 |
+| `clean-all`              | Delete build artifacts and cache files                 |
+| `clean-cache`            | Remove cache files                                     |
+| `coverage`               | Generate coverage reports (text, HTML, XML)            |
+| `dc`                     | Run docker compose with Doppler-mounted .env           |
+| `docker-build`           | Build Docker images                                    |
+| `docker-shell`           | Open a shell in a service container                    |
+| `docker-start`           | Start Docker Compose services                          |
+| `docker-stop`            | Stop and remove Docker Compose services                |
+| `docs-check`             | Check if the documentation builds correctly            |
+| `docs-deploy`            | Publish docs to GitHub Pages                           |
+| `docs-serve`             | Serve the documentation (localhost:8080)               |
+| `doppler-create-config`  | Create a new Doppler branch config                     |
+| `doppler-create-token`   | Create a Doppler service token for this directory      |
+| `doppler-delete-config`  | Delete a Doppler branch config                         |
+| `doppler-set-token`      | Configure a preexisting Doppler service token          |
+| `doppler-upload-secrets` | Upload a local .env file to Doppler                    |
+| `format`                 | Auto-format code (Ruff)                                |
+| `mise-setup-completions` | Install mise shell completions for the current shell   |
+| `pre-commit`             | Run all pre-commit hooks on all files                  |
+| `publish`                | Upload distributions to PyPI                           |
+| `release`                | Automate version bump, changelog, and publish          |
+| `setup-cli`              | Install the project's CLI globally via uv              |
+| `setup-dev`              | Bootstrap dev environment and install pre-commit hooks |
+| `setup-prod`             | Set up the project environment                         |
+| `test`                   | Run tests with pytest                                  |
+| `tox`                    | Run tests across multiple Python versions              |
+| `upgrade`                | Upgrade all dependencies to latest compatible versions |
 
 For the full list and task definitions, see [`mise.toml`](https://github.com/bassemkaroui/python-template-uv/blob/main/template/mise.toml.jinja).