Update PRD architecture: work-driven core and Peripheral split#49
Merged
Conversation
…encing Document the settled v1 product shape from the ObjC Core comparison: Peripheral/DiscoveredPeripheral public types, work-driven connection with Approach B reconnect, FR-10 before commands, and supporting design notes.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates ReliaBLE’s product documentation to lock in the intended v1 architecture and sequencing (work-driven connection core, Peripheral handle vs DiscoveredPeripheral scan snapshot, PoweredOn gating, and FR-10-before-commands).
Changes:
- Expands
PRD.mdwith a normative architecture section, explicit connection/reconnect model, and additional FR/NFR clarifications. - Adds an investigation write-up comparing the ObjC “Core” architecture to ReliaBLE and capturing resulting product decisions.
- Adds an external-reviewable design note explaining the
DiscoveredPeripheralvsPeripheraltype split under Swift 6 strict concurrency.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| PRD.md | Locks the v1 target architecture and requirement sequencing (type split, work-driven link, PoweredOn gating, FR-10-first). |
| docs/investigations/objc-ble-vs-reliable-architecture-2026-07-15.md | Captures the ObjC Core comparison trail and resulting product decisions guiding ReliaBLE’s architecture. |
| docs/designs/discovered-peripheral-vs-peripheral-2026-07-15.md | Documents rationale and chosen public API type split for external iOS/BLE review. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+3
to
+5
| **Date:** 2026-07-15 | ||
| **Status:** Proposed product direction (not yet implemented) | ||
| **Audience:** iOS / BLE engineers reviewing ReliaBLE’s public API shape |
Comment on lines
+47
to
+49
| - ObjC docs: `Bluetooth/docs/BLE-Architecture.md`, `Swift6-Translation.md` | ||
| - ObjC Core: `CCBTCentralManager`, `CCBTPeripheral`, `CCBTCommand` | ||
| - ReliaBLE: `PRD.md` (incl. FR-10 from PR #47), `Sources/ReliaBLE/*`, DocC |
itsniper
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the settled v1 architecture from the ObjC Core comparison and product lock-in discussions. Docs-only; no library code changes.
PRD.md— Architecture section; work-driven connection + Approach B reconnect;Peripheral/DiscoveredPeripheralpublic types; PoweredOn await; idle disconnect (global, default 5s); FR-10 before commands; FR-2.4/2.5, FR-11, catalog-ready, sticky discovery filter on handle; implementation sequencing.docs/designs/discovered-peripheral-vs-peripheral-2026-07-15.md— External-reviewable write-up of the type split (Swift 6 constraints, options, decision).docs/investigations/objc-ble-vs-reliable-architecture-2026-07-15.md— Full investigation trail and product decisions.Kept separate from #44 (background scanning/restore) so that feature stays reviewable on its own.
Test plan