Skip to content

Commit b8aa88f

Browse files
authored
Merge pull request #9 from FreeshardBase/worktree-mkdocs-pin-ci
chore: pin docs toolchain and modernize CI image
2 parents d5239e1 + 1ce16c2 commit b8aa88f

5 files changed

Lines changed: 10 additions & 8 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
build:
1313
runs-on: ubuntu-latest
1414
container:
15-
image: python:3.8-buster
15+
image: python:3.12-slim
1616
steps:
1717
- name: Checkout code
1818
uses: actions/checkout@v4

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@ public
22

33
.idea
44

5+
.claude/worktrees
6+
57
venv
68
.venv

agents.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Developer and user documentation site for Freeshard, published at docs.freeshard
77
- **Generator**: MkDocs with Material theme
88
- **Plugins**: blog, glightbox (image lightbox)
99
- **Markdown extensions**: admonitions, details, syntax highlighting, Mermaid diagrams, emoji, markdown-include
10-
- **Dependencies**: `requirements.txt` (mkdocs, mkdocs-material, markdown-include, mkdocs-glightbox)
10+
- **Dependencies**: `requirements.txt` (mkdocs, mkdocs-material, markdown-include, mkdocs-glightbox), pinned to exact versions — MkDocs 1.x is unmaintained and MkDocs 2.0 is not a viable upgrade (no plugin system, no Material support). Do not bump these; the migration target is Zensical, blocked on its blog plugin ([zensical/backlog#30](https://github.com/zensical/backlog/issues/30)).
1111

1212
## Commands
1313

@@ -58,4 +58,4 @@ Supported via `pymdownx.superfences` custom fence. Use ` ```mermaid ` code block
5858

5959
## Deployment
6060

61-
Built and deployed via GitLab Pages. The `site_dir` is `public/` (GitLab Pages convention). Site URL: `https://docs.freeshard.net`.
61+
Built and deployed via GitHub Pages (`.github/workflows/ci.yml`). Every push builds with `mkdocs build --strict`; pushes to `main` also deploy. The `site_dir` is `public/`. Site URL: `https://docs.freeshard.net`.

docs/blog/posts/2023-09-16_app_integration_overhaul/main.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ So to sum up, an app now consists of the following four artefacts:
9393
3. the `docker-compose.yml.template` which is a template for the `docker-compose.yml` file and
9494
4. an image file that is the app's icon.
9595

96-
The docs contain all the details about the new app format [here](../../../developer_docs/overview.md#app-format){target=_blank}.
96+
The docs contain all the details about the new app format [here](../../../developer_docs/overview.md#the-apps-metadata){target=_blank}.
9797

9898
And by the way, I of course also had to migrate all existing apps to the new format - or at least those that actually were used.
9999

requirements.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Documentation static site generator & deployment tool
2-
mkdocs>=1.1.2
2+
mkdocs==1.6.1
33

44
# Add your custom theme if not inside a theme_dir
55
# (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
6-
mkdocs-material>=9.2.0b0
6+
mkdocs-material==9.7.6
77

8-
markdown-include
9-
mkdocs-glightbox
8+
markdown-include==0.8.1
9+
mkdocs-glightbox==0.5.2

0 commit comments

Comments
 (0)