Skip to content

Commit 4c3389e

Browse files
committed
fix: alter syntax in various places so that docs build successfully for the first time
1 parent 9139413 commit 4c3389e

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed
File renamed without changes.

docs/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,16 @@ This documentation is structured to guide you through the template's core philos
1414
:maxdepth: 2
1515
:caption: Contents
1616
17+
quickstart
18+
usage
1719
philosophy
20+
workflow/index
21+
our-chosen-toolchain
22+
topics/index
1823
criteria
1924
getting-started-template-contributing
20-
our-chosen-toolchain
25+
maintenance
26+
glossary
2127
```
2228

2329
## Evaluated Toolchain Topics
@@ -41,7 +47,7 @@ topics/10_packaging-publish
4147
topics/11_container-build
4248
topics/12_task-automation
4349
topics/13_ci-orchestration
44-
topics/14_cd_orchestration
50+
topics/14_cd-orchestration
4551
topics/15_compose-local
4652
topics/16_prod-deploy-guidance
4753
topics/17_dev-containers

docs/topics/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This section contains the detailed documentation for each of the 18 topics that make up the **cookiecutter-robust-python** template's integrated toolchain. For each topic, you will find:
44

55
* The specific goals this area addresses.
6-
* The criteria used to evaluate tools within this area, derived from the template's philosophy ([Template Philosophy](philosophy.md)) and core criteria ([Criteria](criteria.md)).
6+
* The criteria used to evaluate tools within this area, derived from the template's philosophy ([Template Philosophy](../philosophy.md)) and core criteria ([Criteria](../criteria.md)).
77
* A list of the key tools and approaches that were evaluated.
88
* A detailed breakdown and comparison of these tools against the criteria.
99
* The final tool(s) or approach chosen for the template, with a comprehensive justification explaining *why* based on meeting the criteria and comparing favorably against alternatives.

0 commit comments

Comments
 (0)