Files
archie/mkdocs.yml
T
sam 0b408017e0 feat(release): one release stream, one version, one page per version
CHANGELOG.archied.md and CHANGELOG.archie.md were two version streams that
drifted: a release that moved both components had two numbers, two pages and
two tags, and a reader had to visit two files to learn what shipped.

The merged history holds 65 versions from 64 archied and 34 archie sections --
33 that both components released, 31 only archied, one only archie -- so 98
published pages become 65. A version's date is the newest of its sections'
dates, and a component whose own date differs carries it on its label, because
the history has two dates and the merge must not invent one. `## [Unreleased]`
is not a release: it gets no page, and it stays at the top of the file.

A level-two heading is where the merge could silently drop a section, so the
merge is verified by content rather than by the generator: section counts per
source, the merged version set against the exact union, and every source `###`
title present both as a substring and, after stripping the component prefix, as
an identical heading. Counting `##` headings rather than releases overcounts by
one here, which is how the empty `[Unreleased]` block was caught.

- newsgen reads one file and writes `docs/news/<version>.md`, the index, the
  canonical `releases.json`, and `docs/news/redirects.json`. The redirect table
  is what keeps the retired `/news/<component>/<version>/` URLs alive; it is
  generated beside the pages so it cannot drift from them.
- release.sh takes one `--version`, keeps commit and tag (the Woodpecker
  pipeline that will own them does not exist yet), and exits 3 when the commit
  set justifies no release, so a pipeline can finish green without tagging.
- The consumers of the two files follow: the deploy workflow's tag gate and
  release-notes extraction, the zip contents, the update check's changelog
  links, the packaged-path note, the docs skill, and newsgen's tests.

The per-component detail survives as labelled sections inside each release, so
a reader still learns whether archied or the agent changed; what goes away is
the separate numbers and the separate pages.
2026-09-22 17:18:06 +10:00

62 lines
1.8 KiB
YAML

site_name: Archie
site_description: Event Driven Agentic Automation
site_url: https://offloaded.dev/docs/
repo_url: https://github.com/samcharles93/archie-core
edit_uri: edit/main/docs/
copyright: Vectis Labs
# The published set and the reasons for what is held back now live in
# tools/docsite/main.go, which emits the canonical artifact a renderer reads
# (docs/data/generated/docs.json). MkDocs is being retired, so its exclusions are
# not duplicated here: a second copy of a decision is a second thing to keep true.
# The generated release-notes pages are linked from docs/news/index.md and stay
# published, but they are kept out of the derived navigation: a version list
# that grows with every release would push the architecture tree off the screen.
# This is not exclude_docs -- the pages are wanted, just not as nav entries.
not_in_nav: |
news/[0-9]*
theme:
name: material
favicon: public/favicon.svg
features:
- navigation.sections
- navigation.top
- navigation.instant
- content.code.copy
- content.action.edit
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Light mode
markdown_extensions:
- admonition
- attr_list
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.superfences
plugins:
- search
# No nav block on purpose. MkDocs derives the tree from the directory layout, so
# adding a page under docs/architecture/ publishes it without a second edit here.
# A hand-maintained nav is one more thing that goes stale against 600 commits a
# month.