Skip to content

Commit c92fc7c

Browse files
committed
Revert "Reapply "Reapply "Reapply "docs: manually fix a few broken relative links""""
This reverts commit 7b77bd0.
1 parent 7b77bd0 commit c92fc7c

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/topics/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Reading these topics provides a deep understanding of the template's design choi
4444
Many topics involve key concepts and tool categories that interact across different areas:
4545

4646
- **`pyproject.toml`:** The central configuration file used by many tools, defining project metadata, build system, dependencies, and tool-specific settings ([Topic 01](01_project-structure.md)).
47-
- **Command-Line Interface (CLI):** Most tools selected have strong CLIs, crucial for integration into automation ([Criteria](../criteria.md)).
47+
- **Command-Line Interface (CLI):** Most tools selected have strong CLIs, crucial for integration into automation ([Criteria](criteria.md)).
4848
- **Standard Virtual Environments:** Python's built-in way to isolate project dependencies ([Topic 02](02_dependency-management.md)).
4949
- **Container Images (`Dockerfile`, Docker/Podman):** Standard format and tools for creating portable application environments ([Topic 11](11_container-build.md)).
5050
- **Layered Workflow:** The template organizes automation into distinct layers: Pre-commit (fast local checks), Task Automation (on-demand/comprehensive local runs), and CI/CD (automated verification/deployment) (Topics [12](12_task-automation.md), [13](13_ci-orchestration.md), [14](14_cd-orchestration.md), [18](18_pre-commit-hooks.md)).

docs/workflow/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Here's how the template facilitates your day-to-day coding work:
5959
6060
The workflow extends seamlessly to automation platforms using the Task Automation layer.
6161
62-
1. **Continuous Integration (CI):** Triggered by pushes or pull requests. The CI configuration ([CI Orchestration (13)](../topics/13_ci-orchestration.md)) is a thin layer that:
62+
1. **Continuous Integration (CI):** Triggered by pushes or pull requests. The CI configuration ([CI Orchestration (13)](../topics/13_ci_orchestration.md)) is a thin layer that:
6363
6464
- Sets up the necessary Python version(s) and environment.
6565
- Installs {uv}`uv<>` and {Nox}`nox<>`.
@@ -68,7 +68,7 @@ The workflow extends seamlessly to automation platforms using the Task Automatio
6868
- Reports status back to the version control platform.
6969
This process runs tests and checks reliably across the matrix of Python versions defined in the `noxfile.py` and potentially operating systems supported by the CI platform.
7070
71-
2. **Continuous Deployment / Delivery (CD):** Triggered by events like successful CI runs on the main branch or Git tags. The CD configuration ([CD Orchestration (14)](../topics/14_cd-orchestration.md)) is also a thin orchestration layer:
71+
2. **Continuous Deployment / Delivery (CD):** Triggered by events like successful CI runs on the main branch or Git tags. The CD configuration ([CD Orchestration (14)](../topics/14_cd_orchestration.md)) is also a thin orchestration layer:
7272
- Sets up the environment.
7373
- Manages secure credentials ({API tokens}`pypi-trusted-publishers<>` for PyPI, registry secrets).
7474
- Runs Task Automation commands to build artifacts: `uvx nox -s build:package` ([Packaging Build (09)](../topics/09_packaging-build.md)), `uvx nox -s build:container` ([Container Build (11)](../topics/11_container-build.md)).

0 commit comments

Comments
 (0)