From 9d1047f551f24fd9ea6153658bd1ff19a974c150 Mon Sep 17 00:00:00 2001
From: Minijackson <minijackson@riseup.net>
Date: Thu, 26 Feb 2026 10:47:00 +0100
Subject: [PATCH] docs-template: small improvements

- add a changelog and link to the source repo by default
- add a comment in the previously empty redirects file
- remove redundant "documentation" in toctree captions
---
 documentation-tasks/template/README.md         |  1 +
 documentation-tasks/template/docs/changelog.md |  9 +++++++++
 documentation-tasks/template/docs/index.md     | 18 +++++++++++++-----
 .../template/docs/redirects.txt                |  6 ++++++
 4 files changed, 29 insertions(+), 5 deletions(-)
 create mode 100644 documentation-tasks/template/docs/changelog.md

diff --git a/documentation-tasks/template/README.md b/documentation-tasks/template/README.md
index 9fe3346..827e935 100644
--- a/documentation-tasks/template/README.md
+++ b/documentation-tasks/template/README.md
@@ -7,6 +7,7 @@
 - Copy every file from the template to the root directory of your project, including hidden files, excluding the README.md
 - Change the project name in `docs/pyproject.toml`
 - Change the project name in `docs/conf.py`
+- Change the project name and source code repository URL in `docs/index.md`
 - Choose your profiles, remove the unneeded ones by:
   - Removing the directory
   - Removing the toctree in `docs/index.md`
diff --git a/documentation-tasks/template/docs/changelog.md b/documentation-tasks/template/docs/changelog.md
new file mode 100644
index 0000000..2819e60
--- /dev/null
+++ b/documentation-tasks/template/docs/changelog.md
@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## Unreleased
+
+*Add your changes here.*
diff --git a/documentation-tasks/template/docs/index.md b/documentation-tasks/template/docs/index.md
index 234c0ff..266f125 100644
--- a/documentation-tasks/template/docs/index.md
+++ b/documentation-tasks/template/docs/index.md
@@ -3,7 +3,7 @@
 Insert content here.
 
 ```{toctree}
-:caption: Operator documentation
+:caption: Operator
 :maxdepth: 3
 :glob:
 
@@ -14,7 +14,7 @@ operator/references/index
 ```
 
 ```{toctree}
-:caption: Integrator documentation
+:caption: Integrator
 :maxdepth: 3
 :glob:
 
@@ -25,7 +25,7 @@ integrator/references/index
 ```
 
 ```{toctree}
-:caption: System admin documentation
+:caption: System admin
 :maxdepth: 3
 :glob:
 
@@ -36,7 +36,7 @@ sysadmin/references/index
 ```
 
 ```{toctree}
-:caption: Developer documentation
+:caption: Developer
 :maxdepth: 3
 :glob:
 
@@ -47,7 +47,7 @@ developer/references/index
 ```
 
 ```{toctree}
-:caption: Contributor documentation
+:caption: Contributor
 :maxdepth: 3
 :glob:
 
@@ -56,3 +56,11 @@ contributor/guides/index
 contributor/explanations/index
 contributor/references/index
 ```
+
+```{toctree}
+:titlesonly:
+:caption: Resources
+
+changelog
+Source code repository <https://github.com/Olog/phoebus-olog>
+```
diff --git a/documentation-tasks/template/docs/redirects.txt b/documentation-tasks/template/docs/redirects.txt
index e69de29..58eabea 100644
--- a/documentation-tasks/template/docs/redirects.txt
+++ b/documentation-tasks/template/docs/redirects.txt
@@ -0,0 +1,6 @@
+# This file contains page redirections,
+# so that we don't break URLs when renaming pages.
+#
+# For more information, see:
+# https://sphinxext-rediraffe.readthedocs.io/en/latest/
+