Skip to content

docs: remove private-ADR references from the public repo#63

Merged
simons-plugins merged 3 commits into
mainfrom
docs/remove-private-adr-refs
Jun 12, 2026
Merged

docs: remove private-ADR references from the public repo#63
simons-plugins merged 3 commits into
mainfrom
docs/remove-private-adr-refs

Conversation

@simons-plugins

@simons-plugins simons-plugins commented Jun 12, 2026

Copy link
Copy Markdown
Owner

ADR-0006 lives in the private Domio repo, but README, CLAUDE.md, INSTALL.md, MATTER.md, the PRD, HANDOVER's section heading, and the live Pages page (matter.html) all referenced it — pointing public readers at a document they can't reach.

All references are replaced with self-contained wording; docs/MATTER.md / matter.html already explain the share model fully and now stand as the public record of the decision. No reference to the private repo's ADR (or the workspace mirror) remains — verified with a repo-wide grep.

Bonus accuracy fix prompted by review: the fabrics paragraph's "typically 5+" now states the real reason — the Matter spec requires every certified device to accept at least five fabrics (the SupportedFabrics minimum); many accept more.

Docs-only; 765 tests pass. Version: 2026.2.23 → 2026.2.24 (patch, for the version-check gate). Pages updates on merge.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Clarified Matter "share model" commissioning explanation and architecture decision documentation
    • Expanded Fabrics documentation to explicitly state the 5-fabric minimum requirement for certified devices
    • Enhanced Firmware updates section with ecosystem OTA provider delivery paths, including Apple Home example
  • Chores

    • Version bumped to 2026.2.24

ADR-0006 lives in the private Domio repo; the public repo and the
GitHub Pages site were pointing readers at a document they cannot
reach. All references replaced with self-contained wording — the share
model is fully explained in docs/MATTER.md / matter.html, which now
stand as the public record of the decision. Also tightened the fabrics
claim while in there: "typically 5+" → the spec requires every
certified device to accept at least five fabrics.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@simons-plugins, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 13 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5db0ab6a-21f4-4c0d-9284-36bec594ae83

📥 Commits

Reviewing files that changed from the base of the PR and between acde048 and b1ccb5c.

📒 Files selected for processing (2)
  • docs/MATTER.md
  • docs/matter.html
📝 Walkthrough

Walkthrough

This PR consolidates Matter plugin documentation by removing internal ADR-0006 references and redirecting readers to user-facing guides, expands the Matter commissioning and firmware documentation with clarity on specifications and OTA providers, synchronizes the HTML documentation mirror, and increments the plugin version.

Changes

Documentation consolidation and enrichment

Layer / File(s) Summary
Reference consolidation across project docs
CLAUDE.md, README.md, INSTALL.md, docs/HANDOVER.md, docs/PRD-indigo-matter-plugin.md
Removes ADR-0006 citations from project docs and metadata; redirects readers to HANDOVER.md for current state and MATTER.md for architecture decision details. Updates PRD cross-references and pending-items scope.
Matter documentation enhancements and HTML sync
docs/MATTER.md, docs/matter.html
Expands MATTER.md share-model commissioning phrasing (as plugin's founding decision), clarifies that certified Matter devices must accept at least five fabrics, and distinguishes vendor-app vs. ecosystem-OTA firmware-delivery routes with concrete examples (Apple Home auto-updates, Tapo plug observation). HTML documentation synchronized with matching updates.
Version bump
indigo-matter.indigoPlugin/Contents/Info.plist
Updates CFBundleShortVersionString and CFBundleVersion to 2026.2.24.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


🐰 References gone, guidance clear,
ADR pointers disappear,
MATTER.md now leads the way,
Fabrics, firmware—clearer than before today!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately and concisely describes the main objective: removing references to ADR-0006 from the public repository. It clearly identifies the primary change across all modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-private-adr-refs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

simons-plugins and others added 2 commits June 12, 2026 23:42
…dor apps

Apple Home auto-updates Matter accessory firmware (observed on the
house Tapo plug); the vendor app just typically gets releases first.
Soften the vendor-app-only framing in MATTER.md and matter.html.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…d count

"Many accept more" oversold it: each fabric slot costs persistent
storage, so embedded SDKs default to the minimum and most devices ship
exactly five. Say "treat five as your planning number" instead.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@simons-plugins simons-plugins merged commit c2358ed into main Jun 12, 2026
2 of 3 checks passed
@simons-plugins simons-plugins deleted the docs/remove-private-adr-refs branch June 12, 2026 22:46
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