chore: reorganise repo layout — apps/ subtree, CONTRIBUTING.md, PUBLISHING.md#11
Merged
Merged
Conversation
…SHING.md Move the three sample apps into a shared apps/ directory so platform projects live alongside each other rather than cluttering the repo root: iOSApp/ → apps/ios/ macOSApp/ → apps/macos/ androidApp/ → apps/android/ Add a mise task `open:android` that opens the project root (where settings.gradle.kts lives) in Android Studio. Move contributor/maintainer docs out of the mkdocs public site: docs/contributing.md → CONTRIBUTING.md (GitHub surfaces this automatically) docs/publishing.md → .github/PUBLISHING.md (maintainer-only runbook) Update every reference: mise.toml task dirs and descriptions, settings.gradle.kts projectDir, .gitignore xcodeproj ignore paths, CLAUDE.md module layout, mkdocs.yml nav, and all cross-links in README, docs, workflow files, and per-app READMEs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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
apps/directory (apps/ios,apps/macos,apps/android) to declutter the repo root and group platform projects togethermise run open:androidtask that opens the project root (wheresettings.gradle.ktslives) in Android Studiodocs/contributing.md→CONTRIBUTING.mdat the repo root (GitHub surfaces this automatically on the repo home and PR pages)docs/publishing.md→.github/PUBLISHING.md(maintainer-only runbook, clearly scoped out of the public docs site)What changed
Directory moves (via
git mv, history preserved):iOSApp/→apps/ios/macOSApp/→apps/macos/androidApp/→apps/android/Reference updates across the codebase:
mise.toml— taskdir,run, and description fields forxcodeproj:ios,xcodeproj:macos,open:ios,open:macos,open:android(new),clean,lint:swift,format:swiftsettings.gradle.kts—projectDirfor:androidAppnow points atapps/android; Gradle project name is unchanged.gitignore— xcodeproj ignore paths updatedCLAUDE.md— module layout table and SPM local-dev notemkdocs.yml—contributing.mdandpublishing.mdremoved from navREADME.md,reachable/README.md,apps/ios/README.md,apps/macos/README.md,docs/installation.md,.github/workflows/ci.yml,.github/workflows/release.yml,gradle/libs.versions.tomlReviewer notes
:androidAppproject name is intentionally preserved — changing it would be a breaking change for anyone running./gradlew :androidApp:assembleDebug. OnlyprojectDirwas updated.docs/check.pyvalidates that every.mdunderdocs/appears in the mkdocs nav — since the files moved out ofdocs/, it won't flag them.macOSAppreference indocs/platforms/macos.mdis the Xcode scheme name, not a directory path — correctly left unchanged.