Two fixes to the published site, both about not shipping something false. exclude_docs held back prds/ but let ui-service-boundary.md through, because architecture/migration-decisions.md links to it three times. That PRD in turn links to service-decomposition.md and config-schema.md, so the exclusion was still producing two dead links on the published site. Letting those two through closes the chain: the build now reports no excluded-link references at all. generated-documentation.md's "Step 9: CI" said no workflow builds, checks or publishes documentation. Adding .github/workflows/docs.yml made the first clause false. Restated to say what that workflow does and, more importantly, what it deliberately does not: it does not run docsgen, regenerate contracts.json, or publish. Generated-artifact drift is still gated locally by task check, which is the split that section exists to protect, since a CI job that regenerated output could paper over uncommitted differences rather than fail on them.
68 lines
1.9 KiB
YAML
68 lines
1.9 KiB
YAML
site_name: Archie
|
|
site_description: Event Driven Agentic Automation
|
|
site_url: https://docs.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
|
|
|
|
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.
|