Files
verdande/mkdocs.yml
T
kristianwindandClaude Opus 5 70d7398d5a docs: skriv det ned, der er blevet bygget
API-dokumentationen har fulgt med hele vejen — der er en prøve, der fejler,
hvis en rute ikke står i openapi.yaml, og den fangede mig fire gange i går.
Brugervejledningen har ikke fulgt med, og det er den, folk læser.

Nyt: en side om beskeder — hvad der udløser en, hvorfor gentagne
rettelser bliver slået sammen, push pr. apparat og mærket på ikonet. En
om at åbne links i en anden browser, som mest af alt handler om, hvad en
webside ikke kan: hverken se hvilke browsere der findes eller vælge
mellem dem. Og en om tællingen af installationer, som ikke stod nogen
steder overhovedet — en melding, der er slået til som udgangspunkt, har
en pligt til at være skrevet ned, også når ingen har spurgt.

Rettet: AI-siden beskrev to funktioner, hvor der nu er syv, og
listen over hvad der sendes hvorhen var derfor forkert som en påstand om
noget privat. Noter-siden manglede deling med en e-mailadresse og hvad
`@Sofie` gør. Mail-siden manglede den anden vej ind i indbakken.
Konfigurationen sagde stadig, at versionstjekket kun kunne se efter.

Og tagbeskeden når nu frem. Den ER annonceringen — skrevet på produktets
eget sprog til dem, der bruger det — og udgivelsen på GitHub blev fyldt
med en autogenereret liste over commit-overskrifter i stedet, som er
skrevet til dem, der læser koden. Nu står teksten øverst og listen under
den. Linjen med linket til udgivelsen selv tages af: en side, der linker
til sig selv, hjælper ingen.

Dokumentationen bygges nu også på en PR. `mkdocs build --strict` fejler
på et link til en side, der ikke findes, og at bygge først efter merge er
at få det at vide på main.

Co-Authored-By: Claude Opus 5 <[email protected]>
2026-09-09 08:52:54 +02:00

93 lines
2.3 KiB
YAML

site_name: verdande
site_description: Self-hosted tasks and projects, shared. One binary, SQLite inside it.
site_url: https://kristianwind.github.io/verdande/
repo_url: https://github.com/kristianwind/verdande
repo_name: kristianwind/verdande
edit_uri: edit/main/docs/
# Not the default `site/` — that directory holds the landing page, which is a
# separate thing deployed to a separate place.
site_dir: site_build
theme:
name: material
language: en
# The same two-theme arrangement as the app itself, and the same accent.
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/weather-sunny
name: Switch to light
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/weather-night
name: Switch to dark
features:
- navigation.instant
- navigation.sections
- navigation.top
- content.code.copy
- search.suggest
font:
text: Inter
code: JetBrains Mono
extra_css:
- stylesheets/verdande.css
nav:
- Home: index.md
- Setting it up:
- As a Rune: rune.md
- With Docker: self-hosting.md
- Configuration: configuration.md
- Using it:
- Signing in: signing-in.md
- Quick add: quick-add.md
- Notes: notes.md
- Notifications: notifications.md
- Opening links: links.md
- Filters: filters.md
- Importing from Todoist: import.md
- Connecting things:
- Calendar: calendar.md
- Feeds and CalDAV: caldav.md
- Mail to task: mail.md
- Mailboxes: mailboxes.md
- Claude (MCP): mcp.md
- AI features: ai.md
- Privacy:
- The install count: beacon.md
# openapi.yaml is deliberately not in the nav: MkDocs copies it to the site as a
# file, and api.md links to it. A nav entry expects a page to render.
- Reference:
- API: api.md
markdown_extensions:
- admonition
- attr_list
- def_list
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
plugins:
- search
# The pinned toolchain lives in docs/ so the Pages workflow can cache on it; it is
# not a page.
exclude_docs: |
requirements.txt