Skip to content

Commit 8ce18d0

Browse files
cpcloudclaude
andauthored
docs(website): refresh house profile guide and media (#945)
## Summary - Rewrite the house profile guide for the #919 overlay UX: tab opens a three-column grid (stacks on narrow terminals), Enter edits fields inline, `Bsmnt` is a toggle, `p` in edit mode remains the full-form path - Update the field table with the abbreviated overlay labels (`Fndtn`, `Wire`, `Ft²`, `Bed`, etc.) and re-capture `docs/static/images/house-profile.webp` - Re-record `images/demo.webp` + `videos/demo.webm` so the README demo shows the new collapsed strip and inline overlay - Refresh `.claude/codebase/patterns.md` overlay priority order (adds house, notePreview, opsTree, docSearch) and bump its verified date --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent d3feed2 commit 8ce18d0

5 files changed

Lines changed: 51 additions & 31 deletions

File tree

.claude/codebase/patterns.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- Copyright 2026 Phillip Cloud -->
22
<!-- Licensed under the Apache License, Version 2.0 -->
3-
<!-- verified: 2026-03-10 -->
3+
<!-- verified: 2026-04-16 -->
44

55
# Code Patterns & Conventions
66

@@ -9,7 +9,8 @@
99
### Model-Update-View (Bubble Tea)
1010
- Model.Update(msg) dispatches by message type, then by mode
1111
- Model.View() -> buildView() -> baseView + overlay stack
12-
- Overlays: dashboard, calendar, chat, help, column finder, note preview, extraction log
12+
- Overlays (bottom-up; later renders on top): dashboard, house profile, calendar,
13+
note preview, ops tree, column finder, doc search, extraction, chat, help
1314
- overlay.Composite() for centering with dimmed background
1415

1516
### TabHandler Polymorphism
@@ -20,10 +21,13 @@ No scattered FormKind/TabKind switches outside the handler.
2021
### Rendering Pipeline
2122
```
2223
View() -> buildView()
23-
-> buildBaseView() [house + tab bar + table/form + status bar]
24-
+ overlays (priority order: dashboard > calendar > notes > colFinder > extraction > chat > help)
25-
-> overlay.Composite()
24+
-> buildBaseView() [collapsed house strip + tab bar + table/form + status bar]
25+
+ overlays in priority order (top of stack wins):
26+
dashboard > house > calendar > notePreview > opsTree > colFinder
27+
> docSearch > extraction > chat > help
28+
-> overlay.Composite() with dimmed base
2629
```
30+
Full-screen first-run house form short-circuits buildView before any overlay.
2731

2832
### Data Flow
2933
```

docs/content/docs/guide/house-profile.md

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,57 @@ On first launch (with no existing database), micasa presents the house profile
1515
form automatically. The `Nickname` field is required; everything else is
1616
optional. Fill in what you know now and come back later for the rest.
1717

18-
## Viewing the profile
18+
## Header strip
1919

20-
Press <kbd>tab</kbd> to toggle the house profile display above the table.
21-
The collapsed view shows a single line with key stats:
20+
A one-line collapsed summary is always pinned above the tab bar:
2221

2322
```
24-
Elm Street · Springfield, IL · 4bd / 2.5ba · 2,400 sqft · 1987
23+
Elm Street Springfield, IL · 4 bd / 2.5 ba · 2.4k ft² · 1987 · ○ 3
2524
```
2625

27-
The expanded view shows three sections:
26+
The pill on the left is your house nickname. Vitals follow: city/state,
27+
bed/bath, square footage (k-abbreviated, `` when units are metric), and year
28+
built. The trailing `○ N` warning appears when `N` fields are still empty.
2829

29-
- **Structure**: year built, square footage, bedrooms/bathrooms, foundation,
30-
wiring, roof, exterior, basement
31-
- **Utilities**: heating, cooling, water, sewer, parking
32-
- **Financial**: insurance carrier/policy/renewal, property tax, HOA
30+
## Overlay
3331

34-
## Editing the profile
32+
Press <kbd>tab</kbd> to open the house profile overlay. An identity header
33+
line shows the nickname, address (click to open Google Maps), and a
34+
filled/total completion fraction. Structure, Utilities, and Financial render
35+
side-by-side on wide terminals and stack vertically on narrow ones.
3536

36-
Enter Edit mode (<kbd>i</kbd>), then press <kbd>p</kbd> to open the house profile form. The
37-
form is organized into the same sections (Basics, Structure, Utilities,
38-
Financial). Save with <kbd>ctrl+s</kbd>, cancel with <kbd>esc</kbd>.
37+
Navigation:
38+
39+
- <kbd>↑</kbd>/<kbd>↓</kbd> move within a column
40+
- <kbd>←</kbd>/<kbd>→</kbd> jump to the previous/next column
41+
- <kbd>enter</kbd> on a field opens an inline editor; <kbd>enter</kbd> again saves, <kbd>esc</kbd> cancels
42+
- <kbd>enter</kbd> on a toggle field (e.g. `Bsmnt`) flips the value without opening the editor
43+
- <kbd>tab</kbd> or <kbd>esc</kbd> closes the overlay
44+
45+
Empty values render as a red ∅ glyph so unfilled fields stand out.
46+
47+
## Full form edit
48+
49+
For a guided form-style pass through every field, enter Edit mode
50+
(<kbd>i</kbd>) and press <kbd>p</kbd>. Fields are grouped by section
51+
(Identity, Structure, Utilities, Financial). Save with <kbd>ctrl+s</kbd>,
52+
cancel with <kbd>esc</kbd>.
3953

4054
## Fields
4155

42-
| Section | Field | Type | Notes |
56+
| Section | Label | Type | Notes |
4357
|--------:|-------|------|-------|
44-
| Basics | `Nickname` | text | Required. Display name for your house |
45-
| Basics | `Address` | text | Street, city, state, postal code |
46-
| Structure | `Year built` | number | Whole number |
47-
| Structure | `Square feet` / `Lot` | number | Interior and lot size |
48-
| Structure | `Bedrooms` / `Baths` | number | Baths can be decimal (e.g., 2.5) |
49-
| Structure | `Foundation`, `Wiring`, `Roof`, `Exterior`, `Basement` | text | Free text |
50-
| Utilities | `Heating`, `Cooling`, `Water`, `Sewer`, `Parking` | text | Free text |
51-
| Financial | `Insurance carrier` | text | Company name |
52-
| Financial | `Insurance policy` | text | Policy number |
53-
| Financial | `Insurance renewal` | date | Shows on dashboard when due |
54-
| Financial | `Property tax` | money | Annual amount (e.g., 4200.00). Formatted in your [configured currency]({{< ref "/docs/reference/configuration#locale-section" >}}) |
55-
| Financial | `HOA name` / `fee` | text / money | Name and monthly fee. Formatted in your configured currency |
58+
| Identity | `Name` | text | Required. Display name for your house |
59+
| Identity | `Addr 1` / `Addr 2` | text | Street lines |
60+
| Identity | `City` / `State` / `ZIP` | text | Postal code autofills city/state when known |
61+
| Structure | `Year` | number | Year built |
62+
| Structure | `Ft²` / `Lot` | number | Interior and lot area (`` under metric units) |
63+
| Structure | `Bed` / `Bath` | number | Baths can be decimal (e.g. 2.5) |
64+
| Structure | `Fndtn`, `Wire`, `Roof`, `Ext` | text | Free text |
65+
| Structure | `Bsmnt` | toggle | Yes/No -- flips on <kbd>enter</kbd> |
66+
| Utilities | `Heat`, `Cool`, `Water`, `Sewer`, `Parking` | text | Free text |
67+
| Financial | `Ins carrier` | text | Company name |
68+
| Financial | `Ins policy` | text | Policy number |
69+
| Financial | `Ins renewal` | date | Shows on dashboard when due |
70+
| Financial | `Prop tax` | money | Annual amount. Formatted in your [configured currency]({{< ref "/docs/reference/configuration#locale-section" >}}) |
71+
| Financial | `HOA` / `HOA fee` | text / money | Name and monthly fee in your configured currency |
-297 KB
Loading

images/demo.webp

277 KB
Loading

videos/demo.webm

627 KB
Binary file not shown.

0 commit comments

Comments
 (0)