Skip to content

v1.61: documentation for code review and a frontend refresh - #58

Merged
RickUsingGitHub merged 1 commit into
mainfrom
claude/amber-app-rebuild-6zrcqo
Nov 9, 2026
Merged

RickUsingGitHub merged 1 commit into
mainfrom
claude/amber-app-rebuild-6zrcqo

Conversation

@RickUsingGitHub

Copy link
Copy Markdown
Owner

What changes

Documentation only, plus comments; no behaviour changes.

  • README.md restructured for users:
    • getting started, what each tab does and where the numbers come from;
    • data completeness, privacy, developer commands and links to the docs below;
    • limitations and the disclaimer, unchanged.
  • docs/ARCHITECTURE.md:
    • script load order, the Amber namespace and a module map;
    • the data model: sites, usage items, the IndexedDB cache, plan configs and the planner's half-hourly year;
    • how each tab works, including the planner engine;
    • storage keys, external data (AEMO, PVGIS), the CSP, build, tests, CI and the release steps.
  • docs/FRONTEND.md, the UI contract for a redesign:
    • the constraints: no JS build, the CSP, prebuilt Tailwind, the IDs and data-* hooks the JS and tests use, help keys, and not using Amber's branding;
    • the page and tab inventory, the styling system and the JS-built UI;
    • responsive and accessibility notes, writing style, and known UI issues and opportunities.
  • docs/REVIEW.md: invariants, risk areas, known technical debt, questions for reviewers and a test map.
  • CLAUDE.md: short working rules for AI coding agents (commands, codebase rules, release checklist).
  • Module header comments for the 13 modules that had none.

Testing

  • All unit tests pass.
  • All 54 Playwright tests pass locally.

Generated by Claude Code

- README restructured: getting started, what each tab does, where the numbers come from,
  privacy, developer commands and links to the new docs.
- docs/ARCHITECTURE.md: script load order and the Amber namespace, a module map, the data model
  (sites, usage items, the cache, plan configs, the planner's year), how each tab works, the
  planner engine, storage keys, external data, CSP, build, tests, CI and releases.
- docs/FRONTEND.md: what a redesign must keep (no JS build, CSP, prebuilt Tailwind, IDs and
  data attributes the JS and tests use, help keys, independence from Amber's branding), the
  page and tab inventory, styling, JS-built UI, responsive and accessibility notes, writing
  style and known UI issues.
- docs/REVIEW.md: invariants, risk areas, known technical debt, questions for reviewers and a
  test map.
- CLAUDE.md: short working rules for AI coding agents.
- Header comments for the modules that had none (api, app, bill, calendar, charts, constants,
  costs, csv, monthly, stats, storage, templates, time). No behaviour changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01L7aZZe8i8qyWD6cwhnihsr
@RickUsingGitHub
RickUsingGitHub merged commit 3598234 into main Nov 9, 2026
1 check passed
@RickUsingGitHub
RickUsingGitHub deleted the claude/amber-app-rebuild-6zrcqo branch November 9, 2026 23:37
RickUsingGitHub added a commit that referenced this pull request Nov 15, 2026
…6zrcqo

v1.61: documentation for code review and a frontend refresh
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.

2 participants