Skip to content

Cut stale SDK docs and fold the Android example into sdks/android - #4460

Merged
neekolas merged 4 commits into
nm/sdk-cleanup-6from
nm/sdk-cleanup-9
Oct 7, 2026
Merged

neekolas merged 4 commits into
nm/sdk-cleanup-6from
nm/sdk-cleanup-9

Conversation

@neekolas

@neekolas neekolas commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Delete docs/self-hosted/sdk-migration/handoff.md and docs/self-hosted/sdk-finish-baseline.md. They held cutover receipts, lane ownership, and PENDING gates that no longer apply.
  • Move the only live content of the handoff (how to run check-examples) into a new README section, "Compile the examples".
  • Delete the old Android example app apps/android/xmtpv3_example. sdks/android/example already covers every part of it.
  • Remove stale Phase 2 and "Task 14" text from crates/xmtp_sdk/AGENTS.md.

No SDK behavior change. No test change.

Stacked on #4458.

Changes

File Change
docs/self-hosted/sdk-migration/handoff.md Deleted
docs/self-hosted/sdk-finish-baseline.md Deleted
docs/self-hosted/sdk-migration/README.md Intro no longer links the handoff. New ### Compile the examples section (commands use the dev/nix-shell prefix). Removed "pending in the handoff" reader text.
apps/android/xmtpv3_example/** Deleted (38 files; most lines are gradle/verification-metadata.xml)
Cargo.toml exclude keeps apps/android, one entry per line, with a comment. It guards ignored Gradle output that a checkout keeps after the delete.
sdks/android/CONTRIBUTING.md Dropped the sentence about the separate consumer and its gradle/library.lockfile
nix/lib/filesets.nix binaries drops the apps/android/xmtpv3_example source
README.md Structure tree drops the apps/android row. The sdks/android row says it holds the example app.
crates/xmtp_sdk/AGENTS.md Phase 2 paragraph replaced by "Package preparation does not publish a product."; "Task 14" text replaced by "sdks/android owns its own Gradle graph"; "switched" wording removed

Deleted tests and their coverage

Deleted test Covering test
apps/android/xmtpv3_example/app/src/test/.../ExampleUnitTest.addition_isCorrect (assertEquals(4, 2 + 2)) None needed. It checked no SDK or app behavior. sdks/android/example/src/test/.../ExampleStorageTest is the real unit test of the example app.

No other tests were deleted or trimmed.

Spec backlinks moved

None. No deleted file had a // verifies: link. just spec-check reports 0 errors.

Plan claims that proved wrong or already done

  • docs: split self-hosted migration into SDK Upgrade Guides #4454 did not touch docs/self-hosted/sdk-migration. It only rewrote apps/docs pages. Both retired files still existed, so this PR deletes them.
  • sdks/AGENTS.md "names five test files that no longer exist": already fixed by Fix stream docs and smoke bot consumers #4452. Every path named in sdks/**/AGENTS.md, crates/xmtp_sdk/AGENTS.md, and the root AGENTS.md resolves.
  • "cutover-bench text" in crates/xmtp_sdk/AGENTS.md: already replaced. Only the Phase 2 and Task 14 text remained.
  • apps/xmtp_sdk_bindgen/README.md already exists. No change.
  • "Fold xmtpv3_example into sdks/android/example": nothing unique to move. The code flow, resources, Gradle wiring, and test are already present or have no value. Migration.kt keeps the one-file flow, and check-examples kotlin compiles it.

For the reviewer

  • Cargo exclude keeps apps/android. Without it, a leftover ignored apps/android/ directory breaks every cargo command, because members = ["apps/*"] loads it. Cargo accepts an exclude path that does not exist.
  • Other cutover-era wording remains in the migration README. It does not link the retired files, so a later docs pass can reword it.

Local verification

All passed at 3ee1659:

  • dev/nix-shell 'just lint-markdown'
  • dev/nix-shell 'just lint-treefmt' (0 files changed)
  • dev/nix-shell 'just spec-check' (0 errors)
  • dev/nix-shell 'dev/agent-run cargo metadata --no-deps --offline --format-version 1' with an empty apps/android/xmtpv3_example/.gradle/ present: exit 0. Exit 101 with the exclude entry removed.
  • nix-instantiate --parse nix/lib/filesets.nix

Not run: just android build. This PR does not touch sdks/android.

🤖 Generated with Claude Code

Note

Remove stale SDK docs and delete apps/android example in favor of sdks/android

  • Deletes the retired apps/android/xmtpv3_example and removes it from the Nix Cargo source fileset and the README.md repository tree. The Kotlin SDK in sdks/android now owns its example app and Gradle graph.
  • Rewrites the migration guide in docs/self-hosted/sdk-migration/README.md to drop cutover-handoff notes and add a compile-examples section covering per-package builds and host-specific example checks for Swift, Kotlin, Node, and browser.
  • Updates crates/xmtp_sdk/AGENTS.md and sdks/android/CONTRIBUTING.md to remove references to the removed Android project and its separate lockfile graph.
  • Adds ignore rules in .gitignore for JKS, keystore, and google-services.json files.
  • Behavioral Change: apps/android stays excluded in Cargo.toml so leftover Gradle output is not treated as workspace content.

Macroscope summarized 07acc72.

neekolas and others added 2 commits October 6, 2026 18:54
Delete docs/self-hosted/sdk-migration/handoff.md and
docs/self-hosted/sdk-finish-baseline.md. They held cutover receipts and
lane ownership that no longer apply. The migration README keeps the
check-examples instructions in a new "Compile the examples" section and no
longer links to the handoff.

Delete apps/android/xmtpv3_example. sdks/android/example already covers its
one flow (local signer, client open, group create, send, end) with the same
generated API, and its resources are identical template files. Remove the
old path from the Cargo workspace exclude, nix/lib/filesets.nix and the
README structure.

Cut the Phase 2 and Task 14 text from crates/xmtp_sdk/AGENTS.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keep "apps/android" in the workspace exclude. A checkout can keep ignored
Gradle output from the retired example, and the "apps/*" member glob would
then fail to load it. Remove the CONTRIBUTING sentence about the separate
consumer's gradle/library.lockfile, which was in the deleted app.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@neekolas
neekolas requested review from a team as code owners October 7, 2026 02:59
@neekolas
neekolas added this pull request to stack #4461 October 7, 2026 02:59
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread apps/android/xmtpv3_example/.gitignore Outdated
@macroscopeapp

macroscopeapp Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Approvability

Verdict: Not approved

Macroscope's review found this PR not approvable — This is primarily a cleanup of a retired Android example and stale SDK documentation, with no apparent production runtime or public API change. It also changes repository-wide credential ignore behavior, and the Spec Compliance and Security checks remain incomplete.

You can add or adjust custom eligibility rules. Learn more.

The retired Android example's .gitignore held the only rules for them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.86%. Comparing base (d536a0b) to head (07acc72).

Additional details and impacted files
@@                 Coverage Diff                  @@
##           nm/sdk-cleanup-6    #4460      +/-   ##
====================================================
- Coverage             87.86%   87.86%   -0.01%     
====================================================
  Files                   539      539              
  Lines                102659   102659              
====================================================
- Hits                  90204    90201       -3     
- Misses                12455    12458       +3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@neekolas
neekolas merged commit e04a511 into self-hosted Oct 7, 2026
66 checks passed
@neekolas
neekolas deleted the nm/sdk-cleanup-9 branch October 7, 2026 03:54

Copy link
Copy Markdown
Contributor Author

8.0.0 documentation tracking: #4704 (Overhaul docs site for 8.0.0 SDK).

This merged PR is included in the completed implementation list.

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