Repository navigation
Describe the android/ layout in the documents (#522) - #527
Merged
Merged
Conversation
CLAUDE.md's orientation names the four Gradle builds under android/ beside the Swift package, and every document that named a pre-move path or a root ./gradlew now names the path under android/ and the command in the form #525 chose, (cd android && ./gradlew ...). ADR bodies are records and are untouched; the committed benchmark reports are generated records and are too. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01MJAhQmFgdRRAKUaMHibQLe
…ndroid/ The Swift ref: comments name the Kotlin files under android/, the scripts' comments name the command as it is run from the root, and the benchmark's report writer links PRD.md and the telemetry schema three levels up, which is where they are from android/benchmark/<out>/ (the link was already wrong before the move, one level short). Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01MJAhQmFgdRRAKUaMHibQLe
…s, rewrap the comments that ran long, and name the CI advice from the root Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01MJAhQmFgdRRAKUaMHibQLe
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.
Closes #522
The documents now describe the
android/layout from #521. Each command is spelled the way #525 spelled it,(cd android && ./gradlew …).What changed
CLAUDE.mdorientation: the table's rows are nowandroid/,android/build-logic/,android/demo/andandroid/benchmark/, besidePackage.swift+ios/. A new intro sentence says what stays at the root and that Gradle runs from insideandroid/. The Spotless paragraph now saysspotlessApplyinandroid/reachesdemo/,benchmark/andbuild-logic/, and that no.ktfile lives outsideandroid/. Prose paths are prefixed (goldens,qoe-floors.tsv,benchmark/phase3/,robolectric.properties, the daemon-criteria files,settings.gradle.kts,libs.versions.toml,api/released/). Where the prose meant the Gradle root project, "root build" now reads "library build", because "root" now means two different things.docs/files,ios/CLAUDE.md, the two iOS READMEs, the three devicelab manuals,android/benchmark/README.md,android/api/released/README.mdandthird-party/moq/README.md. Code blocks keep their aligned comment columns.android/api/released/README.mdlinked../../docs/…, which after the move resolves toandroid/docs/; it is now../../../.android/benchmark/README.md's../links are now../../. A link checker over every tracked.mdfile now reports only the four links in the committed benchmark reports, which are left as they are; the reason is below.ref:comments nameandroid/superplayer-*/…, and the comments inPackage.swift,ios/MoQ/Package.swiftandDemoApp.swiftwere changed the same way. So were the "not part of./gradlew check" comments inios/check,ios/hunt-leaksand the devicelab scripts, the usage block inandroid/benchmark/bench,.editorconfig, the fixture tests' KDoc (now matching theirUPDATE_COMMANDconstants), andBenchmarkMatrixTest's KDoc. Two CI comments that tell a contributor what to type are changed too.Decisions
ReportWriternow links../../../PRD.mdand../../../docs/telemetry-schema.md. Both are correct fromandroid/benchmark/out/and fromandroid/benchmark/phase3/, the only two placesbenchwrites (--out DIRexcepted). Before the move the link was one level short. The committed reports,baseline/(frozen) andphase3/(the current reference), are generated records of a run at a recorded commit. Editing them by hand would make each one differ from what its generator wrote, so they keep their broken../PRD.md. The nextbench --baselinewrites a correct link.android/(gradle/libs.versions.toml,superplayer-abr/src/test/qoe-floors.tsv,demo/build.gradle.kts,./gradlew updateGoldenTraces,benchmark/phase3/). Each reads correctly from inside the Gradle build, andCLAUDE.md's orientation now says where that build is. None of them points a reader at something that is not there, which is the bar Documents describe the android/ layout #522 sets for an addendum.CHANGELOG.mdentry: the changelog is "for someone deciding whether to take a new version", and moving the source tree changes no coordinate, no artifact and no behaviour. TheUnreleasedsection's own paths were corrected; there are no released entries.GoldenFile.UPDATE_COMMANDis unchanged, as Move the Android builds under android/ #525 argued.Remaining grep hits (outside
docs/adr/), with the reason each staysdemo/bbb.hang(docs/testing.md, a devicelab log fixture): a MoQ broadcast name, not a path.android/, inside a context that says so: thePRD.mdtree undersuperplayer/android/, README's and CONTRIBUTING's "the library build inandroid/reachesdemo/…", the CI anddevicelab/lib/common.shcomments next toGRADLE_DIR/GRADLE_ROOT, the CIrun: ./gradlew …steps (which run withworking-directory: android), anddevicelab/lab's andmoq-smoke's./gradlewcalls, which run after acdinto the Gradle directory.android/../gradlew …is correct where Gradle runs, andApiSurface's "Run./gradlew updateApiSurface" is printed to someone already inandroid/.Review (two axes, kept separate)
Package.swiftcomment line went past 100 columns after a rewrap..editorconfigstill said "three builds"; "root" was ambiguous; the longref:line inPlaybackDecision.swift; a redundant "Androidandroid/demo/"; a CI comment that lost the word "copies"; a dangling string fragment inReportWriter../gradlew, and "root build" read ambiguously.Tests
(cd android && ./gradlew assemble check --max-workers=1)passed: 1238 tests, 0 failures. That includesCompatibilityDocumentTest(28),ModulePhaseRuleTest(16),TelemetrySchemaDocumentTest,DoctorDocumentTestandTransportDocumentTest.spotlessCheck,verifyLicenseHeaderandverifyModulePhaseRule.(cd android/benchmark && ./gradlew spotlessCheck testDebugUnitTest --tests '*ReportHonestyTest')passed.(cd android && ./gradlew --version)prints theDaemon JVM:line.(cd android && ./gradlew help)succeeds.devicelab/test/selftestpasses.android/benchmark/bench --helpprints the new usage.Skipped
ios/check: only Swift comments changed, so the macOS CI job on this PR covers it.🤖 Generated with Claude Code
https://claude.ai/code/session_01MJAhQmFgdRRAKUaMHibQLe