Repository navigation
docs: iPhone/Obsidian Quick Start, 0.2.0 README, reproducible acceptance suite - #22
Merged
Merged
Conversation
…nce suite - docs/obsidian.md: add a Quick Start (prerequisites, setup, first run, key knobs) at the top; clarify the Dataview-format wording; link the acceptance record. - README.md: lead "What's new" with 0.2.0, add a compact table of capabilities validated on a real iPhone, link the Quick Start and acceptance record. - docs/ibridge-acceptance-0.2.0.md (new): environment, ground rules, copy-pasteable fictional fixtures (Markdown, boolean and rich CSV adapters, Dataview, duplicate titles, dependencies, dashboards), the 88-row matrix by section, blocked rows and how to complete them, findings, iPhone Mirroring tips, partial-title recipe, restoration checklist, summary (85 PASS incl. 3 Mac-only, 3 BLOCKED, 0 failed). - docs/ibridge-testing.md: link the acceptance record; renumber the duplicated section 9; join the traceability table rows that a blank line had split from their header. - docs/guide.md: link the Quick Start and the acceptance record. Documentation only: no tools, template or CI changes.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #22 +/- ##
=======================================
Coverage 93.03% 93.03%
=======================================
Files 18 18
Lines 3734 3734
=======================================
Hits 3474 3474
Misses 260 260 🚀 New features to boost your workflow:
|
TheLinuxGuy
enabled auto-merge
October 27, 2026 06:53
TheLinuxGuy
disabled auto-merge
October 27, 2026 06:53
TheLinuxGuy
enabled auto-merge
October 27, 2026 06:54
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
Documentation only (no
_tools/,_template/, CI,.gitignoreorframework_guard.pychanges).docs/obsidian.md(prerequisites, setup, first run on the phone and how to confirm the first commit, four key knobs). Every command and flag was checked against_tools/icloud_bridge.py; defaults (interval 5, settle 120, notificationserrors, text edits off, rename off) were read from the code.docs/ibridge-acceptance-0.2.0.md: environment, ground rules (every PASS from the real scheduled job), copy-pasteable fictional fixtures, the 88-row matrix by section, the 3 BLOCKED rows and how to complete them, findings, iPhone Mirroring tips, the default-settings partial-title recipe, a restoration checklist and a summary (88 = 85 PASS incl. 3 Mac-only + 3 BLOCKED, 0 failed). The fixture recipe was replayed end to end in a scratch sandbox (setup --no-schedule, thensyncanddoctor); no real LaunchAgent or vault was touched.docs/ibridge-testing.md,docs/guide.md; correct a stale Dataview sentence indocs/obsidian.md; renumber the duplicated "### 9." section and rejoin traceability-table rows that a blank line had split from their header (they rendered as raw pipes) indocs/ibridge-testing.md.Not claimed anywhere: offline-reconnect, a fresh vault's Tasks plugin load on the phone, a visible notification banner. Android and Windows are unsupported. Private evidence (paths, usernames, tester-local hashes) is not included.
Verification
uv run .github/scripts/test_public_docs.py: 248/248 passeduv run _tools/selftest.py: 829/829 passedpython3 .github/scripts/test_ci_scripts.py: passeduvx ruff check .: passedgit diff --check: clean; every added link and anchor resolves (checked withdocslib.heading_anchors)Other documentation review
Changes made:
docs/obsidian.md: Dataview sentence said its behavior "needs the real-device acceptance test"; reworded to what was validated (Tasks plugin's Dataview format, row 2.7) and what was not (Dataview's own query engine).docs/obsidian.md,docs/guide.md: pointers to the Quick Start and the acceptance record where readers previously had only the checklist.docs/ibridge-testing.md: duplicate "### 9." heading renumbered to 10; two blank lines split traceability rows F1-F5 and F6-F8 from their header; note that the 0.2.0 evidence now exists and which rows remain open.README.md:icloud_bridge.pytool-table row updated to describe import of supported edits as local commits.Proposed, not made (debatable or larger):
docs/maintainers.md"Review and publish": add a step to confirm the acceptance record (or a rerun) covers the commit being released.docs/ibridge-testing.mdfindings 3 and 6: could add the observed Mac-to-phone delivery delay (up to about 3 minutes) and cross-link finding 6 to row 10.5 of the acceptance record.docs/obsidian.mdis now long (about 460 lines); consider splitting the task-format and adapter reference into their own pages in a later PR.