README.md

Documentation

The repository keeps maintained documentation and current product screenshots. The documentation policy is in AGENTS.md. Every file under docs/ is listed below so new material has an explicit purpose. Open work lives in GitHub Issues; the guides describe supported behavior. Agents maintain both through the documentation workflow.

Maintained references

  • Changelog: notable widget changes by version and unreleased changes. Future GitHub release notes come from this file.
  • Usage and settings: panel and popup options, provider setup, cost history, notifications, and widget defaults.
  • Development: QML ownership, regression checks, runtime verification, PR delivery and CI follow-up, repository maintenance, and agent instructions. Read before code or tooling changes.
  • Provider settings descriptor: proposed upstream CLI contract for generic settings. It is not a shipped contract.
  • Cost history: daily model data, selection behavior, and the pinned Linux CLI evidence behind the popup.
  • Translations: adding and checking a language catalog.
  • CLI 0.56.2 parity baseline: verified official Linux contracts at that comparison date. The usage guide describes current Plasma behavior; later scoped checks in the cost and settings documents do not replace this full audit.
  • Settings decisions: Plasma settings, privacy, refresh behavior, and the macOS 0.56.8 comparison.

Earlier CLI evidence

These small reports preserve version-specific evidence used by later audits. They are historical comparisons, not current feature plans. Preserve their original findings; a new audit names the report it supersedes and its exact versions. Completed recommendations are tracked in issues and current guides.

Product screenshots

These synthetic captures appear in the project README and the widget package. Replace the relevant image when the product changes instead of adding dated before/after copies.

Historical work artifacts

Past captures, completed plans, and review logs are available in Git history before the cleanup. New temporary artifacts go in ignored dist/review/ or the OS temp directory. PRs record verification results; this index records documents worth maintaining.