Skip to content

docs: bring README + architecture to the final state#101

Merged
fleveque merged 1 commit into
mainfrom
docs/final-state
Jun 14, 2026
Merged

docs: bring README + architecture to the final state#101
fleveque merged 1 commit into
mainfrom
docs/final-state

Conversation

@fleveque

Copy link
Copy Markdown
Owner

The migration is feature-complete and ready to cut over, but the tech docs still read as "in active construction" with stale (planned) markers. This brings them current.

docs/architecture.md

  • Status → feature-complete / ready to cut over (links the cutover runbook).
  • Context tree + provider table de-planned: AI (Gemini), AlphaVantage fallback, logos LLM resolver, and Telegram are all live now; added content/ and demo/.
  • New sections for the subsystems that landed but weren't documented: Portfolio (dividends ledger/importers/charts, buy plan, Path to Freedom), AI (provider seam + per-user quota + admin bypass), Telegram (dormant → cutover flip), content drafts, admin tooling, demo mode, and i18n.
  • Deployment now covers CI deploy-on-merge and the kamal-proxy cutover (host re-route, not DNS).
  • Updated the Oban consumers list and the SettingsLive description (currency + language + sharing + Telegram).

README.md

  • New Features section summarizing what the app does.
  • Full context list in the project structure; note the optional GEMINI_API_KEY and the dev mailbox (/dev/mailbox) for magic links.

Docs-only — no code changes.

🤖 Generated with Claude Code

The migration is feature-complete and ready to cut over; the tech docs
still read as "in active construction" with stale (planned) markers.

  - architecture.md: status → feature-complete/ready-to-cut-over; context
    tree + provider table de-planned (AI/AlphaVantage/logos-LLM/Telegram
    all live); new sections for Portfolio (dividends/importers/charts/buy
    plan/freedom), AI (+ quota + admin bypass), Telegram (dormant→cutover),
    content drafts, admin tooling, demo mode, i18n; deployment section
    covers CI deploy-on-merge + the kamal-proxy cutover (not DNS).
  - README.md: add a Features section, list all contexts, note the
    optional GEMINI_API_KEY + the dev mailbox for magic links.

Docs-only.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@fleveque fleveque merged commit b49a5cc into main Jun 14, 2026
1 check passed
@fleveque fleveque deleted the docs/final-state branch June 14, 2026 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant