Skip to content

docs: update documentation for release#1349

Merged
steilerDev merged 1 commit into
betafrom
docs/1332-release-docs
Apr 21, 2026
Merged

docs: update documentation for release#1349
steilerDev merged 1 commit into
betafrom
docs/1332-release-docs

Conversation

@steilerDev
Copy link
Copy Markdown
Owner

Summary

Refresh user-facing documentation to reflect the changes bundled in the beta->main promotion PR #1332:

  • Area hierarchy everywhere -- work items, household items, pickers, and embedded references now document the full ancestor breadcrumb (House / Ground Floor / Kitchen) and the "No Area" filter on list pages.
  • Budget Overview -- rewritten to describe the new area-grouped cost breakdown, clickable summary tiles, and print-friendly output (page margins, nested group boxes, AppShell chrome suppressed).
  • Budget Sources -- rewritten to cover inline expansion, hierarchical area tree, dense columnar rows, multi-select across groups with preserved selection, and the new mass-move modal.
  • Vendors moved to Settings -- budget docs now explain that vendor records live under Settings while invoices remain in the Budget section.
  • Reverse-proxy reliability -- getting-started docs explain the narrower TRUST_PROXY behavior and spoof-resistant rate-limit key.
  • README -- Features list refreshed (area breadcrumbs, No Area filter, Budget Sources mass-move, area-grouped Budget Overview). The protected NOTE block is untouched.
  • RELEASE_SUMMARY.md -- rewritten end-to-end with user-facing prose, grouped "what's new" bullets, an explicit "no breaking changes" statement, and migration notes covering the TRUST_PROXY behavior change and the Vendors menu relocation.
  • .env.example -- short inline comment on TRUST_PROXY noting only the first hop is trusted.

No production code, schema, or test changes are in scope for this PR.

Test plan

  • Docusaurus build succeeds (runs via CI)
  • Spot-check the rendered Budget Overview, Budget Sources, Work Items, and Household Items pages on the docs preview
  • Confirm the README NOTE block is byte-identical to before
  • Confirm RELEASE_SUMMARY.md renders cleanly on GitHub (preview the raw markdown)

Targets beta per the branching strategy in CLAUDE.md. Will be included in the next promotion along with #1332.

Co-Authored-By: Claude docs-writer (Opus 4.6) noreply@anthropic.com

Refresh user-facing documentation to reflect the area-tree hierarchy
rework, Budget Overview and Budget Sources redesigns, Vendors move into
Settings, tightened reverse-proxy handling, and the TypeScript 6.0
upgrade included in the upcoming stable release.

- docs/src: update work items, household items, budget, and
  getting-started guides to cover area breadcrumbs across the app, the
  "No Area" filter, the area-grouped Budget Overview with clickable
  tiles and print styling, the inline-expansion / multi-select /
  mass-move workflow on Budget Sources, and the narrower trustProxy
  behavior for reverse-proxy users.
- docs/src/guides/budget/vendors-and-invoices.md: document the move of
  Vendors into the Settings section while invoices stay in Budget.
- README.md: refresh the Features section (Work Items, Areas & Trades,
  Budget Management) without touching the protected NOTE block.
- RELEASE_SUMMARY.md: rewrite for this release - area hierarchy,
  Budget Overview + Sources redesign, navigation, reliability, and
  TypeScript 6.0 tooling; note no database migration is required and
  describe the trustProxy behavior change for self-hosters.
- .env.example: add a short note next to TRUST_PROXY explaining that
  only the first proxy hop is trusted and rate limiting is now
  spoof-resistant.

Co-Authored-By: Claude docs-writer (Opus 4.6) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

Thank you for your submission! We require all contributors to sign our Contributor License Agreement before we can accept your contribution.

To sign, please comment on this PR with:
I have read the CLA Document and I hereby sign the CLA


I have read the CLA Document and I hereby sign the CLA


Frank Steiler seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@steilerDev steilerDev merged commit f3c8603 into beta Apr 21, 2026
13 of 14 checks passed
@steilerDev steilerDev deleted the docs/1332-release-docs branch April 21, 2026 06:52
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 21, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant