Skip to content

docs: iPhone/Obsidian Quick Start, 0.2.0 README, reproducible acceptance suite - #22

Merged
TheLinuxGuy merged 2 commits into
mainfrom
docs/0.2.0-quickstart-acceptance
Oct 27, 2026
Merged

TheLinuxGuy merged 2 commits into
mainfrom
docs/0.2.0-quickstart-acceptance

Conversation

@TheLinuxGuy

Copy link
Copy Markdown
Owner

Summary

Documentation only (no _tools/, _template/, CI, .gitignore or framework_guard.py changes).

  • Quick Start at the top of 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, notifications errors, text edits off, rename off) were read from the code.
  • README: "What's new" now leads with 0.2.0 (0.1.0 kept as one earlier-release line); a compact table of capabilities that passed on a real iPhone; one-line links to the Quick Start and the acceptance record. Only PASS rows are claimed.
  • New 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, then sync and doctor); no real LaunchAgent or vault was touched.
  • Small fixes elsewhere: link the new pages from docs/ibridge-testing.md, docs/guide.md; correct a stale Dataview sentence in docs/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) in docs/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 passed
  • uv run _tools/selftest.py: 829/829 passed
  • python3 .github/scripts/test_ci_scripts.py: passed
  • uvx ruff check .: passed
  • git diff --check: clean; every added link and anchor resolves (checked with docslib.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.py tool-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.md findings 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.
  • The 0.1.0 README line links the v0.1.0 tag; a 0.2.0 tag link was deliberately not added because the tag does not exist yet. After publishing, swap the Releases-page link for the tag link.
  • docs/obsidian.md is now long (about 460 lines); consider splitting the task-format and adapter reference into their own pages in a later PR.
  • Per-row Tasks version (7.21.0 vs 8.6.0) was not tracked in the source evidence; the acceptance doc says so rather than claiming 8.6.0 for every row. A rerun on 8.6.0 would close that.

…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.
Copilot AI balanced review requested due to automatic review settings October 27, 2026 06:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@codecov

codecov Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.03%. Comparing base (4314663) to head (f95f886).

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@TheLinuxGuy
TheLinuxGuy enabled auto-merge October 27, 2026 06:53
@TheLinuxGuy
TheLinuxGuy disabled auto-merge October 27, 2026 06:53
@TheLinuxGuy
TheLinuxGuy enabled auto-merge October 27, 2026 06:54
@TheLinuxGuy
TheLinuxGuy merged commit 9c0b9aa into main Oct 27, 2026
13 checks passed
@TheLinuxGuy
TheLinuxGuy deleted the docs/0.2.0-quickstart-acceptance branch October 27, 2026 07:03
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.

2 participants