Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
build:
runs-on: ubuntu-latest
container:
image: python:3.8-buster
image: python:3.12-slim
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@ public

.idea

.claude/worktrees

venv
.venv
4 changes: 2 additions & 2 deletions agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Developer and user documentation site for Freeshard, published at docs.freeshard
- **Generator**: MkDocs with Material theme
- **Plugins**: blog, glightbox (image lightbox)
- **Markdown extensions**: admonitions, details, syntax highlighting, Mermaid diagrams, emoji, markdown-include
- **Dependencies**: `requirements.txt` (mkdocs, mkdocs-material, markdown-include, mkdocs-glightbox)
- **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)).

## Commands

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

## Deployment

Built and deployed via GitLab Pages. The `site_dir` is `public/` (GitLab Pages convention). Site URL: `https://docs.freeshard.net`.
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`.
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ So to sum up, an app now consists of the following four artefacts:
3. the `docker-compose.yml.template` which is a template for the `docker-compose.yml` file and
4. an image file that is the app's icon.

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

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.

Expand Down
8 changes: 4 additions & 4 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Documentation static site generator & deployment tool
mkdocs>=1.1.2
mkdocs==1.6.1

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

markdown-include
mkdocs-glightbox
markdown-include==0.8.1
mkdocs-glightbox==0.5.2
Loading