Adds an mkdocs.yml, a landing page, and `task docs:site` / `task docs:serve`. Deliberately hosting-agnostic: MkDocs is the same input Backstage TechDocs consumes, so choosing where this lands later costs nothing. exclude_docs holds back four subtrees, since everything under docs/ would otherwise be published. archive/ is superseded design and would compete with the current architecture for a reader's attention; inspiration/ discusses other products by name; prds/ are open decisions rather than settled design; github-token.md is credential setup. One PRD is let back through because architecture/migration-decisions.md links to it three times, and a page excluded out from under a live link is just a 404 with extra steps. No nav block. MkDocs derives it from the directory layout, so a new page under docs/architecture/ publishes without a second edit, and there is no hand-maintained tree to drift against the repository. Builds --strict, so a dead internal link fails rather than ships.
66 lines
1.9 KiB
YAML
66 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
|
|
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.
|