Files
archie/mkdocs.yml
T
sam 93418801e9 feat(docs): publish generated news and per-version release notes
Derive a public news page and one release-notes page per component version
from CHANGELOG.archied.md and CHANGELOG.archie.md, the notes the release
process already freezes.

- tools/newsgen writes docs/news/releases.json, the canonical artifact a host
  renders from, plus the MkDocs pages. Check mode fails when the committed
  files lag a changelog edit, and runs in task check; tools/release.sh --tag
  regenerates and stages them in the release commit, skipping files already
  current.
- mkdocs.yml keeps the version pages out of the derived navigation without
  excluding them from the site.
2026-09-22 05:03:29 +10:00

76 lines
2.3 KiB
YAML

site_name: Archie
site_description: Event Driven Agentic Automation
site_url: https://offloaded.dev/
repo_url: https://github.com/samcharles93/archie-core
edit_uri: edit/main/docs/
copyright: Vectis Labs
# Everything under docs/ is published to the public internet. These subtrees are
# held back deliberately, each for its own reason:
# archive/ superseded design. Publishing it competes with the current
# architecture for a reader's attention, which is the exact
# failure this repo already fights.
# inspiration/ research notes that discuss other products by name.
# prds/ open design decisions, not settled architecture.
# github-token setup notes about credentials.
# Widen this by deleting a line; nothing else needs to change.
exclude_docs: |
archive/
inspiration/
prds/*
!prds/ui-service-boundary.md
!prds/service-decomposition.md
!prds/config-schema.md
github-token.md
# 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/archied/*
news/archie/*
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.