Skip to content

Update docs, README, and CLAUDE.md for full product vision#22

Closed
mabry1985 wants to merge 1 commit intodevfrom
feature/update-docs-readme-and-claudemd-for
Closed

Update docs, README, and CLAUDE.md for full product vision#22
mabry1985 wants to merge 1 commit intodevfrom
feature/update-docs-readme-and-claudemd-for

Conversation

@mabry1985
Copy link

@mabry1985 mabry1985 commented Mar 15, 2026

Summary

Comprehensive documentation update reflecting the full homeMaker product vision — all 9 milestones, gamification, inventory, maintenance, vendors, integrations.

README.md — Update the Features section to include ALL modules (not just the original 5):

  • Home Inventory and Asset Tracking (warranty monitoring, asset valuation, sensor linking)
  • Maintenance Scheduling (recurring obligations, completion history, calendar integration, vendor linking)
  • Vendor Directory (service provider contacts,...

Recovered automatically by Automaker post-agent hook

Summary by CodeRabbit

Release Notes

  • New Features

    • Home Inventory and Asset Tracking for managing household items and assets.
    • Maintenance Scheduling with auto-calculated due dates and vendor integration.
    • Vendor Directory for tracking service providers by trade category.
    • Gamification system featuring Home Health Score, XP progression, achievements, and AI-generated quests.
    • Enhanced IoT Sensor Dashboard with command capabilities and configurable history retention.
    • Secrets Vault with AES-256-GCM encryption for sensitive data.
    • Budget Tracking expansion and Home Assistant and OpenWeatherMap integrations.
  • Documentation

    • Added Tailscale deployment guide and comprehensive module documentation.

@github-actions
Copy link

Hi @mabry1985, thank you for your interest in protoMaker! 🙏

We don't accept code contributions via pull requests.

protoMaker uses an ideas-only contribution model — all implementation is handled by AI agents to maintain architectural consistency and code quality standards.

What you can do instead:

  • 💡 Submit your idea using the Idea Submission template — if accepted, our AI agents will implement it
  • 🐛 Report a bug using the Bug Report template
  • Join the discussion on Discord (invite link TBA) to share feedback

You're welcome to fork the repository and use your changes privately — that's what MIT is for. We just can't merge external code back in.

See CONTRIBUTING.md for the full explanation.

Closing this PR automatically.

@github-actions github-actions bot closed this Mar 15, 2026
@coderabbitai
Copy link

coderabbitai bot commented Mar 15, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 69a5f6d0-52bc-4ce5-9495-45c5bd28b108

📥 Commits

Reviewing files that changed from the base of the PR and between d004f50 and a5a252e.

📒 Files selected for processing (12)
  • .automaker/context/CLAUDE.md
  • .automaker/context/coding-rules.md
  • CLAUDE.md
  • README.md
  • docs/deployment/tailscale.md
  • docs/modules/budget.md
  • docs/modules/gamification.md
  • docs/modules/inventory.md
  • docs/modules/maintenance.md
  • docs/modules/sensors.md
  • docs/modules/vault.md
  • docs/modules/vendors.md

📝 Walkthrough

Walkthrough

This PR introduces comprehensive documentation for a home management application called homeMaker, establishing a shared SQLite database architecture, adding six new feature modules (Gamification, Inventory, Maintenance, Vendors, Budget, Vault), updating AI context files with standardized coding rules and patterns, and providing deployment and module-specific guidance.

Changes

Cohort / File(s) Summary
AI Context & Coding Rules
.automaker/context/CLAUDE.md, .automaker/context/coding-rules.md
Reorganizes AI context to emphasize shared database patterns, gamification integration, and module-specific invariants. Adds structured coding rules for Gamification, Inventory, Maintenance, Vendors, and Shared Database enforcing constraints like XP awards through services, monetary amounts in cents, and foreign key relationships.
Project Documentation
README.md, CLAUDE.md
Expands feature list to include Home Inventory, Maintenance Scheduling, Vendor Directory, Gamification with Home Health Score, Home Assistant/Weather integrations, and Secrets Vault. Updates architecture section to document shared homemaker.db with WAL mode; extends environment variables and security specifications.
Deployment
docs/deployment/tailscale.md
New deployment guide covering Tailscale prerequisites, environment setup, Docker Compose configuration, vault key generation, backup strategies, and network access instructions.
Module Documentation
docs/modules/budget.md, docs/modules/gamification.md, docs/modules/inventory.md, docs/modules/maintenance.md, docs/modules/sensors.md, docs/modules/vault.md, docs/modules/vendors.md
Seven new module documentation files defining data models, API endpoints, and integration patterns. Gamification details Home Health Score calculation and 30 achievements; Maintenance covers interval-based scheduling with auto-calculated due dates; Vault describes AES-256-GCM encryption; others specify field constraints and relationships.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 A burrow of docs now stands so tall,
With gamified quests and inventory haul,
One database shared, encrypted and bright,
The homeMaker flourishes—organized right!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/update-docs-readme-and-claudemd-for
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

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