📝 docs: correct some mistakes in the docs

Author: bassemkaroui

README.md

@@ -44,7 +44,7 @@ A modern, batteries‑included [Copier](https://github.com/copier-org/copier) te
 - **Release & changelog**
     - [Conventional Commits](https://www.conventionalcommits.org/) + [Commitizen](https://github.com/commitizen-tools/commitizen) + [gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji)
     - Automated `CHANGELOG.md` updates
-    - Release new versions ➜ `make release`
+    - Release new versions ➜ `mise run release`
 
 - **Docker & Docker Compose**
     - Generate `Dockerfile` + `compose.yaml` for deployment and `compose.override.yaml` for development overrides (hot-reload, exposed ports, GPU support)

docs/features/documentation.md

@@ -5,7 +5,7 @@ Generated projects include a fully configured [MkDocs](https://github.com/mkdocs
 ## What's Included
 
 - **MkDocs Material** theme with dark/light mode, search, and navigation features
-- **mkdocstrings** for auto-generated API documentation from docstrings
+- **mkdocstrings** for auto-generated documentation from docstrings
 - **Code highlighting** with copy buttons and annotations
 - **Admonitions**, tabbed content, and other Material extensions
 
@@ -62,12 +62,12 @@ The CI/CD pipeline also deploys docs automatically on pushes to `main`.
 ```
 docs/
   index.md          # Landing page
-  modules.md        # Auto-generated API reference
+  modules.md        # Auto-generated reference
   css/
     overrides.css   # Custom styling
 mkdocs.yml          # MkDocs configuration
 ```
 
-## API Documentation
+## Documentation
 
-The template uses [mkdocstrings](https://mkdocstrings.github.io/) with the Python handler to generate API docs from your source code docstrings. Simply document your modules and classes with docstrings, and they appear in the docs automatically.
+The template uses [mkdocstrings](https://mkdocstrings.github.io/) with the Python handler to generate docs from your source code docstrings. Simply document your modules and classes with docstrings, and they appear in the docs automatically.

docs/features/optional.md

@@ -52,4 +52,4 @@ Adds [pytest-xdist](https://github.com/pytest-dev/pytest-xdist) for parallel tes
 
 Enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard using [Commitizen](https://github.com/commitizen-tools/commitizen). Optionally includes [gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji) for emoji-enhanced commit messages (`cz_gitmoji`).
 
-Enables automated changelog generation and semantic version bumping via `make release`.
+Enables automated changelog generation and semantic version bumping via `mise run release`.

template/README.md.jinja

@@ -148,12 +148,6 @@ Contributions are welcome! Please read the [development setup]({{ documentation
 Contributions are welcome! Please read the [development setup](docs/development/setup.md) and [contributing guidelines](CONTRIBUTING.md) before submitting a PR.
 {%- endif %}
 
-{%- if repository_provider == 'github' %}
-
-> [!note]
-> This project was scaffolded with [python-template-uv](https://github.com/bassemkaroui/python-template-uv).
-{%- endif %}
-
 {% if copyright_license != "No License" -%}
 ## 📄 License
 

template/docs/development/ci-cd.md.jinja

@@ -99,8 +99,8 @@ A Dependency Dashboard issue is created in the repository for visibility and man
 ## Release Flow
 
 1. Make commits following the [Conventional Commits](https://www.conventionalcommits.org/) format
-2. Run `make release` locally — this bumps the version via commitizen, pushes commits and tags
+2. Run `mise run release` locally — this bumps the version via commitizen, pushes commits and tags
 3. The tag push triggers CI: **checks** → **tests** → **release** + **deploy-docs**{% if publish_to_pypi %} + **publish-package**{% endif %}
-4. Preview first with `make release -- --dry-run`
+4. Preview first with `mise run release -- --dry-run`
 {%- endif %}
 {%- endif %}

template/docs/development/contributing.md.jinja

@@ -6,7 +6,7 @@
 2. Create a new branch for your feature or fix
 3. Install development dependencies: `make setup-dev`
 4. Make your changes
-5. Run checks before committing: `make check`
+5. Run checks before committing: `make check-all`
 6. Submit a pull request
 
 ## Code Quality
@@ -102,7 +102,7 @@ mise run docs:serve
 ```
 ///
 
-API documentation is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/).
+Documentation is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/).
 {%- if repository_provider == 'github' %}
 For deployment details, see the [CI/CD Pipeline](ci-cd.md) page.
 {%- endif %}

template/docs/development/task-runner.md.jinja

@@ -53,17 +53,9 @@ This is done via `$(subst -,:,$@)` in the Makefile. You never need to edit both
 
 You can pass extra arguments to pytest:
 
-/// tab | make
-```bash
-make test -- -k "test_specific"
-```
-///
-
-/// tab | mise
 ```bash
 mise run test -- -k "test_specific"
 ```
-///
 
 ### Formatting
 
@@ -103,8 +95,8 @@ mise run test -- -k "test_specific"
 The `docker:build` and `docker:start` tasks accept `--dev` / `--prod` flags:
 
 ```bash
-mise run docker:build --dev    # build with dev compose override
-mise run docker:start --prod   # start production containers
+mise run docker:build [--dev]    # build with dev compose override
+mise run docker:start --prod     # start production containers
 ```
 {% endif %}
 {%- if with_doppler %}

template/docs/getting-started/usage.md.jinja

@@ -26,11 +26,11 @@ This will display all available commands and options.
 - `.env` files
 - Command-line arguments
 
-Refer to the [API Reference](../modules.md) for available configuration options.
+Refer to the [Reference](../modules.md) for available configuration options.
 {% endif %}
 
 ## Next Steps
 
-- Browse the [API Reference](../modules.md) for detailed documentation of all modules
+- Browse the [Reference](../modules.md) for detailed documentation of all modules
 - Explore all available commands in the [Task Runner](../development/task-runner.md) guide
 - Check the [Development Setup](../development/setup.md) guide to contribute

template/docs/index.md.jinja

@@ -29,7 +29,7 @@ hide:
 {%- endif %}
 
 [Get Started](getting-started/installation.md){ .md-button .md-button--primary }
-[API Reference](modules.md){ .md-button }
+[Reference](modules.md){ .md-button }
 
 </div>
 
@@ -61,13 +61,13 @@ hide:
 
     [:octicons-arrow-right-24: Development setup](development/setup.md)
 
--   :material-file-document:{ .lg .middle } **API Documentation**
+-   :material-file-document:{ .lg .middle } **Documentation**
 
     ---
 
-    Auto-generated API docs with mkdocstrings. Browse the full API reference for all modules.
+    Auto-generated docs from docstrings with mkdocstrings. Browse the full reference for all modules.
 
-    [:octicons-arrow-right-24: API Reference](modules.md)
+    [:octicons-arrow-right-24: Reference](modules.md)
 {% if with_typer_cli %}
 -   :material-console:{ .lg .middle } **CLI Interface**
 

template/mkdocs.yml.jinja

@@ -17,7 +17,7 @@ nav:
   - Getting Started:
       - Installation: getting-started/installation.md
       - Usage: getting-started/usage.md
-  - API Reference: modules.md
+  - Reference: modules.md
   - Development:
       - Setup: development/setup.md
       - Task Runner: development/task-runner.md