Skip to content

Docs and tooling catch up with what ships - #46

Merged
wenkaifan0720 merged 2 commits into
mainfrom
chore/hygiene-docs
Sep 24, 2026
Merged

wenkaifan0720 merged 2 commits into
mainfrom
chore/hygiene-docs

Conversation

@wenkaifan0720

Copy link
Copy Markdown
Collaborator

This is part 1 of audit batch 5 (hygiene): docs, the probe runner, and package metadata. It has no code changes.

Docs describe what ships. The README, CONTRIBUTING, PORTING and example README described June's macOS-only package, with one cef_host per view and a global IOSurface. They now cover:

  • Windows;
  • one host per profile or host group;
  • the Mach-port surface handoff;
  • the prebuilt download at pod install;
  • per-view JS channels;
  • the generated wire protocol.

The roadmap now lists what is actually next; camera/mic prompts and Windows had already shipped.

specs/ and docs/ move to docs/history/, with an index giving the outcome of each record. Personal absolute paths are stripped. Nothing there describes current code, and the index says so.

tool/run_probes.sh is one table of every real-host probe: what it checks, its timeout, the host it needs (normal, exits at once, or never connects), and whether it runs automatically. --list prints the table.

  • It kills only the processes it started.
  • The old test/run_channel_integration.sh covered 3 probes and ran pkill -9 -f cef_host, which killed every CEF app on the machine, FlutterFlow and Campus included. It is deleted.
  • run_cascade_probe.sh had the same global kill, now scoped to its own app.
  • The soak scripts no longer look for a consumer repo's engine script.

Metadata.

  • SDK floors rise to what CI tests: Dart 3.10, Flutter 3.38. The old floors, Dart 3.4 and Flutter 3.22, were never tested and flutter_lints ^6 already excluded them.
  • The podspec floor is now macOS 12, matching the documented runtime floor.
  • The root pubspec loses its flutter create template comments.
  • Comments that described a GCS-hosted prebuilt now name the GitHub release.

Verified.

  • flutter analyze shows only the existing setStyle info.
  • flutter test: 249 pass.
  • tool/run_probes.sh host_start page_boundary channel against a local host: 5/5 PASS.
  • Against a host that exits at once, the same probes report FAIL.

Still to come in batch 5, after the macOS, Dart and Windows fix PRs land (they touch the same files):

  • Strip the ~300 audit-ID tags and ~250 stale main.mm:NNN citations from code comments.
  • Move PROTOCOL.md to the repo level.
  • Standardise every probe on CEF_PROBE_RESULT.
  • Remove the auth-spike entitlements plist from the hashed host dir.
  • Cut a versioned CHANGELOG section.

🤖 Generated with Claude Code

wenkaifan0720 and others added 2 commits September 23, 2026 23:55
The README, CONTRIBUTING, PORTING and example README still described June's
macOS-only package with one cef_host per view and a global IOSurface. They
now cover Windows, hosts per profile or host group, the Mach-port surface
handoff, the prebuilt download, per-view JS channels and the generated wire
protocol, and the roadmap lists what is actually next.

specs/ and docs/ held finished plans and investigations, some with personal
paths and some contradicting the code. They move to docs/history/ with an
index saying what each one became; personal paths are stripped.

tool/run_probes.sh runs the real-host probes from one table: what each checks,
its timeout, the host it needs, and whether it is automatic. It replaces
test/run_channel_integration.sh, which covered 3 of the probes and killed
every cef_host process on the machine; run_cascade_probe.sh no longer does
either. The soak scripts no longer look for a consumer repo's engine script.

SDK floors rise to what CI tests (Dart 3.10, Flutter 3.38), the podspec to
macOS 12, and the flutter create boilerplate leaves the root pubspec. Comments
that still described a GCS-hosted prebuilt now name the GitHub release.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Raising the SDK floor turns on use_null_aware_elements, which flags the
optional create/thaw/showDevTools arguments.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@wenkaifan0720
wenkaifan0720 merged commit 9346a20 into main Sep 24, 2026
3 checks passed
@wenkaifan0720
wenkaifan0720 deleted the chore/hygiene-docs branch September 24, 2026 07:06
@wenkaifan0720 wenkaifan0720 mentioned this pull request Sep 24, 2026
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