10Backward/docs/index.md

okf_version

okf_version
0.1

Architecture

• System Architecture — Component map of 10Backward: entrypoint, config, logging, runner, state, publishing boundary, and cron wiring.
• Config Schema — Required/optional env vars, validation rules, and the typed Config dataclass.
• Logging & Run Summary — JSON formatter, secret redaction, and structured event helpers.
• Pipeline Runner — How a cron tick synchronizes the blog, matches anniversaries, applies deduplication, publishes to Mastodon, retries failures, and emits run events.
• Anniversary Matching — Jekyll filename/front matter rules, ten-year date matching, leap-day handling, and candidate identifiers.
• Mastodon Publishing — The single success boundary: status composition, 500-character validation, and the Mastodon API call.

Operations

• Environment Variable Setup — Required env vars, renamed keys, and how to populate .env.
• Cron Lifecycle — How entrypoint.sh renders /etc/cron.d/tenbackward and hands off to cron -f.

User Guides

• Daily Run Guide — Tester/operator walkthrough of repository sync, anniversary matching, deduplication, Mastodon publishing, and expected log/output behaviour.