Repository navigation
Cut stale SDK docs and fold the Android example into sdks/android - #4460
Merged
Merged
Conversation
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>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
ApprovabilityVerdict: 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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
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. |
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
docs/self-hosted/sdk-migration/handoff.mdanddocs/self-hosted/sdk-finish-baseline.md. They held cutover receipts, lane ownership, and PENDING gates that no longer apply.check-examples) into a new README section, "Compile the examples".apps/android/xmtpv3_example.sdks/android/examplealready covers every part of it.crates/xmtp_sdk/AGENTS.md.No SDK behavior change. No test change.
Stacked on #4458.
Changes
docs/self-hosted/sdk-migration/handoff.mddocs/self-hosted/sdk-finish-baseline.mddocs/self-hosted/sdk-migration/README.md### Compile the examplessection (commands use thedev/nix-shellprefix). Removed "pending in the handoff" reader text.apps/android/xmtpv3_example/**gradle/verification-metadata.xml)Cargo.tomlexcludekeepsapps/android, one entry per line, with a comment. It guards ignored Gradle output that a checkout keeps after the delete.sdks/android/CONTRIBUTING.mdgradle/library.lockfilenix/lib/filesets.nixbinariesdrops theapps/android/xmtpv3_examplesourceREADME.mdapps/androidrow. Thesdks/androidrow says it holds the example app.crates/xmtp_sdk/AGENTS.mdsdks/androidowns its own Gradle graph"; "switched" wording removedDeleted tests and their coverage
apps/android/xmtpv3_example/app/src/test/.../ExampleUnitTest.addition_isCorrect(assertEquals(4, 2 + 2))sdks/android/example/src/test/.../ExampleStorageTestis 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-checkreports 0 errors.Plan claims that proved wrong or already done
docs/self-hosted/sdk-migration. It only rewroteapps/docspages. 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 insdks/**/AGENTS.md,crates/xmtp_sdk/AGENTS.md, and the rootAGENTS.mdresolves.crates/xmtp_sdk/AGENTS.md: already replaced. Only the Phase 2 and Task 14 text remained.apps/xmtp_sdk_bindgen/README.mdalready exists. No change.xmtpv3_exampleintosdks/android/example": nothing unique to move. The code flow, resources, Gradle wiring, and test are already present or have no value.Migration.ktkeeps the one-file flow, andcheck-examples kotlincompiles it.For the reviewer
excludekeepsapps/android. Without it, a leftover ignoredapps/android/directory breaks every cargo command, becausemembers = ["apps/*"]loads it. Cargo accepts an exclude path that does not exist.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 emptyapps/android/xmtpv3_example/.gradle/present: exit 0. Exit 101 with theexcludeentry removed.nix-instantiate --parse nix/lib/filesets.nixNot run:
just android build. This PR does not touchsdks/android.🤖 Generated with Claude Code
Note
Remove stale SDK docs and delete apps/android example in favor of sdks/android
apps/android/xmtpv3_exampleand removes it from the Nix Cargo source fileset and the README.md repository tree. The Kotlin SDK insdks/androidnow owns its example app and Gradle graph.google-services.jsonfiles.apps/androidstays excluded in Cargo.toml so leftover Gradle output is not treated as workspace content.Macroscope summarized 07acc72.