Migrate user documentation to GitHub Wiki#193
Merged
Conversation
- Replace 590-line README with a 75-line landing page that links to the Wiki and showcases a single end-to-end example
- Delete mkdocs.yml, docs/{guides,index,getting-started,ios-integration,known-limitations,changelog,api}, and the docs publish workflow — content moved to the Wiki at https://github.com/AndroidBroadcast/Featured/wiki
- Keep docs/cc-verification/ and docs/specs/ as internal audit/spec history
- Update Swift comments referencing docs/ios-integration.md to point at the new Wiki page
- Ignore secring.gpg, .build/, .claude runtime files in .gitignore
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
kirich1409
force-pushed
the
docs/wiki-migration
branch
from
ce44952 to
8a7c061
Compare
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 18 files
Tip: cubic can generate docs of your entire codebase and keep them up to date. Try it here.
Re-trigger cubic
There was a problem hiding this comment.
Pull request overview
This PR migrates user-facing documentation from in-repository MkDocs pages to the GitHub Wiki, leaving the README as a compact project entry point while retaining internal audit/spec docs.
Changes:
- Replaces the long README with highlights, a quick Kotlin example, and Wiki links.
- Removes MkDocs configuration, user documentation pages, and the docs publishing workflow.
- Updates Swift sample comments to link to the new Wiki and expands
.gitignorefor local/generated files.
Reviewed changes
Copilot reviewed 17 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Slims README and redirects users to Wiki documentation. |
| mkdocs.yml | Removes MkDocs site configuration. |
| iosApp/iosApp/FeatureFlags.swift | Updates iOS DCE guide link to Wiki. |
| iosApp/iosApp/ContentView.swift | Updates sample setup comment to Wiki link. |
| docs/known-limitations.md | Removes migrated user-facing limitations page. |
| docs/ios-integration.md | Removes migrated iOS integration guide. |
| docs/index.md | Removes MkDocs landing page. |
| docs/guides/r8-verification.md | Removes migrated R8 verification guide. |
| docs/guides/providers.md | Removes migrated providers guide. |
| docs/guides/jvm.md | Removes migrated JVM guide. |
| docs/guides/ios.md | Removes migrated iOS guide. |
| docs/guides/best-practices.md | Removes migrated best-practices guide. |
| docs/guides/android.md | Removes migrated Android guide. |
| docs/getting-started.md | Removes migrated getting-started guide. |
| docs/changelog.md | Removes migrated docs changelog page. |
| docs/api/index.md | Removes migrated API reference page. |
| .gitignore | Adds ignores for local Wiki/Claude/build/signing artifacts. |
| .github/workflows/docs.yml | Removes MkDocs/Dokka Pages publishing workflow. |
| // FeatureFlags.generated.xcconfig when @LocalFlag new_checkout has | ||
| // defaultValue = false. The compiler removes this block in Release. | ||
| // See FeatureFlags.swift and docs/ios-integration.md for setup. | ||
| // See FeatureFlags.swift and https://github.com/AndroidBroadcast/Featured/wiki/iOS-DCE-xcconfig for setup. |
Comment on lines
+50
to
+51
| // Read the generated extension anywhere | ||
| val isEnabled: Boolean = configValues.isNewCheckoutEnabled() |
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
Release-Optimizationpage that leads with the tl;dr: a flag withdefault = falsemakes guarded code unreachable in release builds).mkdocs.yml,docs/{guides,index,getting-started,ios-integration,known-limitations,changelog,api}, and.github/workflows/docs.yml.docs/cc-verification/anddocs/specs/as internal audit/spec history.docs/ios-integration.md..gitignorehardened:secring.gpg,*.gpg,.build/,.claude/agent-memory/,.claude/scheduled_tasks.lockadded.Wiki structure
Out of scope (follow-ups)
CheckoutVariant) not being supported byDataStoreConfigValueProvider. Tracked separately; screenshots will land in a follow-up Wiki commit after the sample is fixed.Test plan
docs/wiki-migration_Sidebarshows on every page