Update docs for inapp SDKs #86
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR comprehensively restructures and updates InApp SDK documentation across multiple platforms (Android, iOS Swift, Flutter, React Native) and adds new advanced documentation sections. Changes include reformatted installation guides with collapsible sections, clarified usage patterns, updated dependency versions, and new documentation pages for advanced features like attestor authentication and verification overrides. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Areas requiring attention:
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
1 of many updates for improving inapp docs. A lot of work still needs to be done. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/docs/js-sdk/verifying-proofs.mdx (1)
24-30: Clarify verification workflow in documentation example.The
verifyProofAPI accepts either a single proof or an array and returns a single boolean indicating overall validity. However, the documentation example is unclear about the intended workflow: it verifies the entireproofsarray at once (line 29), then shows accessing individual proofs by index (lines 36, 41) without explaining whether iteration is necessary or how results map to individual proofs.Update the example to clarify: After
verifyProof(proofs)returns true, should the caller iterate overproofsto extract data, or should individual proofs be verified separately if per-proof handling is needed?
🧹 Nitpick comments (12)
content/docs/react-native/troubleshooting.mdx (2)
20-26: Minor wording improvement.Consider rewording "In the meantime, we recommend" to a shorter alternative like "For now, we recommend" or "Until resolved, we recommend" to improve readability.
36-74: Extract duplicated exception handling code to avoid maintenance burden.This exception handling code block (lines 36-74) is identical to code in
content/docs/react-native/installation.mdx(lines 104-141). Duplicating code examples across documentation creates a maintenance risk—when one is updated, the other may be forgotten.Consider one of these approaches:
- Keep the full example in the troubleshooting guide (as it makes sense contextually) and replace the example in installation.mdx with a link: "For detailed error handling patterns, see Troubleshooting."
- Extract the example to a shared reusable code snippet component if your documentation framework supports it.
- Keep full examples in both places but add a cross-reference comment noting they are identical.
Recommend approach 1 for clarity and maintainability.
content/docs/react-native/installation.mdx (2)
104-141: Resolve duplicated exception handling code.This exception handling code block is identical to the one in
content/docs/react-native/troubleshooting.mdx(lines 36-74). See recommendation in the troubleshooting.mdx review for consolidation strategies. Since the troubleshooting guide is more naturally suited for detailed error handling patterns, consider moving the full example there and referencing it from installation.mdx instead.
151-151: Minor wording improvements for formality.Static analysis suggests replacing three informal phrases:
- Line 151: "check out" → consider "review" or "see"
- Line 163: "feel free to submit" → consider "submit" or "contribute"
- Line 166: "feel free to file" → consider "file" or "report"
These are optional polish improvements for a more formal tone.
Also applies to: 163-163, 166-166
content/docs/flutter/usage.mdx (1)
48-58: Remove duplicate Pre-warming section to avoid maintenance issues.The "Pre-warming" section appears twice with identical content:
- Lines 48-58 (under Quickstart → Starting Verification)
- Lines 216-226 (under Performance optimization)
This duplication creates a maintenance burden—any future updates to pre-warming guidance must be applied in two places.
Recommendation: Keep the pre-warming section in one location only. Based on the structure, the "Performance optimization" section (lines 216-226) is the more appropriate placement. Delete lines 48-58 and keep lines 216-226, OR consolidate into a single comprehensive pre-warming section with a clear location.
Alternatively, if both locations serve different purposes (quick introduction vs. detailed optimization), add a cross-reference from one to the other rather than duplicating the full code and explanation.
Also applies to: 216-226
content/docs/inapp-sdks/advanced/verification-options.mdx (1)
6-7: Unused import: Accordion component not referenced in content.The
AccordionandAccordionscomponents are imported but not used. Consider removing these imports if no accordion sections are planned for this page, or add accordion-formatted content if intended.-import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; +import { Tab, Tabs } from 'fumadocs-ui/components/tabs';content/docs/react-native/install/expo.mdx (1)
44-46: Improve sentence variety in step instructions.Steps 4–6 begin with the repetitive phrase "Click on the". Consider rewording for better readability:
-4. Click on the **Edit Scheme** button. -5. Click on the **Run** tab. -6. Click on the **Arguments** tab and check the **Environment Variables** section. +4. Select the **Edit Scheme** button. +5. Navigate to the **Run** tab. +6. Open the **Arguments** tab and check the **Environment Variables** section.content/docs/inapp-sdks/introduction.mdx (2)
8-8: Fix GitHub branding capitalization.Line 8 contains "Github" but the official spelling is "GitHub" (capital H). This appears twice in the file.
-Following is an example on how we used the [Github Username Provider](https://dev.reclaimprotocol.org/provider/6d3f6753-7ee6-49ee-a545-62f1b1822ae5) with the InApp SDK in an ios native application to verify Github account ownership. +Following is an example on how we used the [GitHub Username Provider](https://dev.reclaimprotocol.org/provider/6d3f6753-7ee6-49ee-a545-62f1b1822ae5) with the InApp SDK in an iOS native application to verify GitHub account ownership.Note: Also consider capitalizing "iOS" on line 8 for consistency with Apple's branding.
32-32: Use more professional phrasing instead of "feel free to".Lines 32 and 35 use the phrase "feel free to," which is informal for technical documentation. Consider more direct alternatives:
-Contributions are welcome! Please feel free to submit a Pull Request. +Contributions are welcome! We encourage you to submit a Pull Request. -Please feel free to file feature requests and bugs at the issue tracker of InApp sdks. +Please file feature requests and bugs at the issue tracker for InApp SDKs.Also applies to: 35-35
content/docs/flutter/installation.mdx (1)
74-76: Consider rewording repetitive "Click" instructions for better readability.The instructions at lines 4–6 begin with identical phrasing ("Click on the..."), which may affect UX clarity. Consider restructuring to improve flow, e.g., "Open your project in Xcode. In the toolbar, click File > Add Package Dependency... then..." This is a minor style improvement.
content/docs/ios-swift/installation.mdx (1)
171-173: Consider rewording repetitive "Click" instructions.Steps 4–6 begin with identical phrasing, similar to the Flutter doc. Consider restructuring for better flow and UX clarity.
content/docs/react-native/install/no-framework.mdx (1)
122-124: Consider rewording repetitive "Click" instructions.Steps 4–6 use identical phrasing. Restructure for improved clarity and consistency with best practices for instructional documentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
content/docs/android/installation.mdx(1 hunks)content/docs/android/usage.mdx(1 hunks)content/docs/flutter/installation.mdx(3 hunks)content/docs/flutter/usage.mdx(1 hunks)content/docs/inapp-sdks/advanced/attestor-auth.mdx(1 hunks)content/docs/inapp-sdks/advanced/intro.mdx(1 hunks)content/docs/inapp-sdks/advanced/meta.json(1 hunks)content/docs/inapp-sdks/advanced/overrides.mdx(3 hunks)content/docs/inapp-sdks/advanced/verification-options.mdx(1 hunks)content/docs/inapp-sdks/introduction.mdx(1 hunks)content/docs/inapp-sdks/meta.json(1 hunks)content/docs/ios-swift/installation.mdx(1 hunks)content/docs/ios-swift/usage.mdx(1 hunks)content/docs/js-sdk/verifying-proofs.mdx(1 hunks)content/docs/meta.json(1 hunks)content/docs/react-native/install/expo.mdx(1 hunks)content/docs/react-native/install/meta.json(1 hunks)content/docs/react-native/install/no-framework.mdx(1 hunks)content/docs/react-native/installation.mdx(1 hunks)content/docs/react-native/meta.json(1 hunks)content/docs/react-native/troubleshooting.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/inapp-sdks/introduction.mdx
[uncategorized] ~8-~8: The official name of this software platform is spelled with a capital “H”.
Context: ...owing is an example on how we used the [Github Username Provider](https://dev.reclaimp...
(GITHUB)
[uncategorized] ~8-~8: The official name of this software platform is spelled with a capital “H”.
Context: ... in an ios native application to verify Github account ownership. <video src="/assets...
(GITHUB)
[style] ~32-~32: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ontributing Contributions are welcome! Please feel free to submit a Pull Request. ### Issues and ...
(FEEL_FREE_TO_STYLE_ME)
[style] ~35-~35: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...Pull Request. ### Issues and Feedback Please feel free to file feature requests and bugs at the i...
(FEEL_FREE_TO_STYLE_ME)
content/docs/react-native/troubleshooting.mdx
[style] ~26-~26: ‘In the meantime’ might be wordy. Consider a shorter alternative.
Context: ...tigating this issue to find a solution. In the meantime, we recommend temporarily removing expo...
(EN_WORDINESS_PREMIUM_IN_THE_MEANTIME)
content/docs/react-native/installation.mdx
[style] ~151-~151: Consider using a more formal alternative.
Context: ...eason error.innerError ``` If you need more help, check out the [Troubleshooting guide](...
(MORE_HELP)
[style] ~163-~163: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...ontributing Contributions are welcome! Please feel free to submit a Pull Request. ### Issues and ...
(FEEL_FREE_TO_STYLE_ME)
[style] ~166-~166: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...Pull Request. ### Issues and Feedback Please feel free to file feature requests and bugs at the i...
(FEEL_FREE_TO_STYLE_ME)
content/docs/react-native/install/expo.mdx
[style] ~44-~44: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t xcscheme in Xcode" width="500" /> 4. Click on the Edit Scheme button. 5. Click...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~45-~45: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Click on the Edit Scheme button. 5. Click on the Run tab. 6. Click on the **A...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~46-~46: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...button. 5. Click on the Run tab. 6. Click on the Arguments tab and check the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/docs/react-native/install/no-framework.mdx
[style] ~122-~122: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t xcscheme in Xcode" width="500" /> 4. Click on the Edit Scheme button. 5. Click...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~123-~123: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Click on the Edit Scheme button. 5. Click on the Run tab. 6. Click on the **A...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~124-~124: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...button. 5. Click on the Run tab. 6. Click on the Arguments tab and check the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/docs/flutter/installation.mdx
[style] ~74-~74: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t xcscheme in Xcode" width="500" /> 4. Click on the Edit Scheme button. 5. Click...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~75-~75: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Click on the Edit Scheme button. 5. Click on the Run tab. 6. Click on the **A...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~76-~76: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...button. 5. Click on the Run tab. 6. Click on the Arguments tab and check the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/docs/ios-swift/installation.mdx
[style] ~171-~171: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t xcscheme in Xcode" width="500" /> 4. Click on the Edit Scheme button. 5. Click...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~172-~172: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Click on the Edit Scheme button. 5. Click on the Run tab. 6. Click on the **A...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~173-~173: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...button. 5. Click on the Run tab. 6. Click on the Arguments tab and check the ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (23)
content/docs/meta.json (1)
9-9: Verify navigation references are updated consistently.Renaming
android-kotlintoandroid(Line 11) and adding the newinapp-sdkssection (Line 9) are structural changes that may affect existing documentation links and user bookmarks. Ensure that any hardcoded references to these paths in other documentation files, GitHub links, or external resources have been updated.Also applies to: 11-11
content/docs/react-native/troubleshooting.mdx (1)
1-102: Overall: Solid troubleshooting guide with practical solutions.The troubleshooting content is well-organized, covers the most common issues (iOS CocoaPods, expo-dev-client incompatibility, UI closure, Android Cronet), and provides clear actionable solutions with code examples. The error fields documentation (lines 76-82) is particularly helpful.
content/docs/react-native/installation.mdx (3)
12-19: Excellent addition of BadgeGroup component.The BadgeGroup with GitHub, docs, and npm badges provides excellent visibility into the SDK's source, documentation, and package registry. This is a nice touch for discoverability.
30-34: Verify that referenced install subguides exist and are properly linked.The installation guide now delegates to two subguides:
/react-native/install/no-frameworkand/react-native/install/expo. Ensure these files exist and are correctly referenced incontent/docs/react-native/install/meta.json(which is provided and looks correct).
41-159: Overall: Well-structured guide with clear verification flow separation.The restructured installation guide effectively separates the quick-start flow from the recommended backend-assisted approach, making it clear to developers when to use each method. The addition of prerequisites, examples, and next-steps sections provides good scaffolding for new users. The link to advanced usage (line 159) appropriately connects to the new InApp SDKs advanced documentation section.
content/docs/inapp-sdks/meta.json (1)
1-7: Solid foundation for InApp SDKs documentation section.The metadata structure is clean and appropriately separates introductory content from advanced topics. This creates a logical information architecture for users to explore basic to advanced SDK usage.
Verify that
introduction.mdxandadvanced/subdirectory withmeta.jsonexist and contain expected content.content/docs/android/installation.mdx (1)
76-76: Good addition of Usage guide link.Adding the cross-reference to the Usage guide provides clear navigation for users completing installation. This mirrors the pattern in other platform documentation and improves discoverability of the next step in the user journey.
content/docs/react-native/install/meta.json (1)
1-7: Clean navigation structure for React Native install variants.The metadata correctly establishes the two installation paths (no-framework and expo) that are referenced in
installation.mdx. The file structure supports the dual-path installation guidance.Verify that
no-framework.mdxandexpo.mdxfiles exist in this directory.content/docs/inapp-sdks/advanced/meta.json (1)
1-9: Well-organized advanced features section.The metadata establishes a clear progression through advanced SDK features: intro to advanced usage, followed by three specific customization areas (verification options, attestor authentication, and overrides). This grouping allows users to selectively dive into the advanced features they need.
Verify that all four referenced pages (
intro.mdx,verification-options.mdx,attestor-auth.mdx,overrides.mdx) exist in this directory.content/docs/flutter/usage.mdx (1)
1-455: Overall: Comprehensive Flutter usage guide with good structure and examples.The Flutter usage documentation is well-organized, covering import/initialization, verification flows, result verification, exception handling, configuration options, context strings, error handling, custom parameters, session management, webview configuration, UI customization, platform-specific considerations, localization, and theming. The code examples are clear and practical. The only structural improvement needed is consolidating the duplicate pre-warming section.
content/docs/ios-swift/usage.mdx (1)
1-59: Documentation simplified and well-structured.The removal of the Advanced Options section aligns with the PR's strategy to consolidate advanced topics in a dedicated section. The quickstart remains clear and actionable, with helpful links to API key guides and provider documentation.
content/docs/inapp-sdks/advanced/intro.mdx (1)
1-14: Clear entry point for advanced documentation.Well-organized introduction page that establishes the navigation structure for advanced features. The relative links are properly formatted.
content/docs/android/usage.mdx (1)
48-54: Streamlined and focused usage guide.The removal of advanced sections in favor of concise descriptions and a link to complete examples maintains clarity while directing users to the advanced documentation. The response object and error handling descriptions are accurate and helpful.
content/docs/react-native/install/expo.mdx (2)
90-92: Verify navigation link format and destination.Line 92 contains a navigation link to the React Native Get Started guide. Confirm that the link format
react-native/installation#using_reclaimis correct for your documentation system (some systems use different anchor formats or require full paths).
1-96: Comprehensive Expo installation guide with helpful warnings.The documentation is well-structured with clear setup instructions, visual guides via GitHub images, and appropriate warnings about Expo Go limitations. The build instructions for both EAS and non-EAS workflows are thorough and practical.
content/docs/inapp-sdks/introduction.mdx (1)
1-42: Well-structured introduction with clear navigation.The introduction effectively sets context for the InApp SDKs with a demo video and clear links to platform-specific installation guides. The sections on advanced usage and community engagement are appropriately placed.
content/docs/inapp-sdks/advanced/overrides.mdx (1)
1-315: Comprehensive override documentation with practical examples and guidance.The overrides documentation is well-structured with clear sections on basic usage, available options, complete examples, and best practices. The addition of real-world examples from repository files and the meeting scheduling link for restricted overrides enhances usability. The Best Practices and Notes sections provide important context for proper implementation.
content/docs/flutter/installation.mdx (1)
49-50: Verify Android target SDK version alignment.The targetSdkVersion was bumped to 36, which is ahead of typical Flutter ecosystem standards and significantly newer than iOS 14.0 minimum. Ensure this version requirement is intentional and that it doesn't create unnecessary friction for developers using older build tools.
content/docs/ios-swift/installation.mdx (2)
11-11: Verify minimum iOS version requirement.The prerequisites state iOS 13 or later, but the Flutter (line 60) and React Native (line 101) installation guides both specify iOS 14.0 as the minimum. Ensure this documentation is aligned—either bump iOS to 14.0 here (lines 50, 86, 180) or verify that SPM, CocoaPods, and manifest methods support iOS 13.
146-158: Good UX improvement: CocoaPods troubleshooting section.The troubleshooting section with clear screenshots and steps for fixing the "User Script Sandboxing" build error is excellent and will reduce support burden. Well done.
content/docs/inapp-sdks/advanced/attestor-auth.mdx (3)
18-40: Excellent TypeScript example with clear async/await pattern.The basic usage example clearly demonstrates how to create an auth request using the @reclaimprotocol/attestor-core library, including proper JSON serialization with B64_JSON_REPLACER. Well structured for developers to adapt.
60-193: Multi-language examples are well-structured and comprehensive.The Kotlin and Swift implementations properly demonstrate both setOverrides for attestor configuration and setVerificationOptions for auth request provision, with appropriate error handling patterns (Result/onSuccess/onFailure). Code examples maintain consistency across platforms while respecting language idioms.
12-12: External documentation link is accessible and functional.The GitHub URL for attestor authentication documentation at
https://github.com/reclaimprotocol/attestor-core/blob/main/docs/run-server.mdreturns HTTP 200, confirming it is accessible and working as expected. No issues identified with the link reference in the documentation.
| /> | ||
| ``` | ||
|
|
||
| add the following to the end of settings.gradle: |
There was a problem hiding this comment.
🧩 Analysis chain
Verify S3 Maven repository accessibility.
The Android setup references a custom S3 Maven repository (https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo). Confirm this URL is publicly accessible and contains the required dependencies, as misconfiguration here would prevent developers from building their projects.
Also applies to: 39-39, 44-44, 57-57, 74-74, 86-86
🏁 Script executed:
#!/bin/bash
# Verify S3 repository accessibility
S3_REPO="https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo"
HTTP_CODE=$(curl -s -o /dev/null -w "%{http_code}" "$S3_REPO")
echo "HTTP Status for $S3_REPO: $HTTP_CODE"
# Attempt to list repository contents
curl -s "$S3_REPO" | head -20Length of output: 391
S3 Maven repository is not accessible—documentation references a non-existent repository path.
The custom S3 Maven repository returns a 404 error with "NoSuchKey," meaning the documented path (https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo) does not exist. This will prevent developers from successfully building projects following this setup guide.
Verify the correct S3 repository URL or provide an alternative Maven repository configuration. This affects lines 32, 39, 44, 57, 74, and 86 in the file.
🤖 Prompt for AI Agents
In content/docs/react-native/install/no-framework.mdx around lines 32, 39, 44,
57, 74, and 86, the docs reference an S3 Maven repository URL that returns 404
(NoSuchKey); update the document to either correct the S3 repository URL to the
working path provided by the infra team or remove the broken S3 entry and
provide a working alternative (for example mavenCentral() or a valid Maven
host/JitPack) along with the exact settings.gradle snippet replacement; ensure
all occurrences of the broken
https://reclaim-inapp-sdk.s3.ap-south-1.amazonaws.com/android/repo URL are
replaced and add a short note on how to obtain the correct S3 path if the S3
repo is intended to be used.
| 1. Make sure to have a platform declaration for your project in your `Podfile` with version 14.0 or higher. | ||
|
|
||
| ```ruby | ||
| platform :ios, '14.0' # or platform :ios, min_ios_version_supported |
There was a problem hiding this comment.
Fix iOS platform version inconsistency.
Line 101 specifies platform :ios, '14.0', but the advanced iOS setup example on line 180 shows platform :ios, '13.0'. Update line 180 to '14.0' to maintain consistency throughout the document and with other platform installation guides (iOS Swift, Flutter).
platform :ios, '13.0'
+platform :ios, '14.0'Also applies to: 180-180
🤖 Prompt for AI Agents
In content/docs/react-native/install/no-framework.mdx around lines 180
(reference from line 101), the advanced iOS setup shows platform :ios, '13.0'
which conflicts with the earlier platform :ios, '14.0'; update the value on line
180 to '14.0' so the document consistently uses iOS 14.0 across examples and
matches other platform guides.
| "pages": [ | ||
| "installation", | ||
| "usage" | ||
| "install", | ||
| "troubleshooting", | ||
| "advanced-usage" | ||
| ] |
There was a problem hiding this comment.
🧩 Analysis chain
Verify all referenced pages exist and are properly configured.
The pages array has been reorganized to include new install variants, troubleshooting, and advanced usage. Ensure that:
installproperly references the install folder withno-frameworkandexpopagestroubleshootingpage exists at the expected pathadvanced-usagecorrectly links to the new advanced documentation section
🏁 Script executed:
#!/bin/bash
# Verify that all pages referenced in react-native/meta.json exist
files_to_check=(
"content/docs/react-native/installation.mdx"
"content/docs/react-native/install/meta.json"
"content/docs/react-native/troubleshooting.mdx"
"content/docs/react-native/advanced-usage.mdx"
)
for file in "${files_to_check[@]}"; do
if [ -f "$file" ]; then
echo "✓ Found: $file"
else
echo "✗ Missing: $file"
fi
done
# Check what pages are currently in react-native directory
echo ""
echo "Pages in react-native directory:"
fd -t f "\.mdx$|meta\.json$" content/docs/react-native/ --max-depth 2Length of output: 512
I found a critical issue: the advanced-usage page referenced in the pages array does not exist. Let me search for where this content might be or what it should reference.
Let me search the codebase for where "advanced-usage" might be referenced or if there's shared advanced documentation:
Let me search the codebase directly for references to "advanced" and check the install meta structure:
🏁 Script executed:
#!/bin/bash
# Check install/meta.json content
echo "=== install/meta.json content ==="
cat content/docs/react-native/install/meta.json
echo ""
echo "=== Search for 'advanced' in docs ==="
rg -i "advanced" content/docs/ --type json --type mdx -A2 -B2 | head -50
echo ""
echo "=== Check other framework docs structure ==="
echo "Web framework pages:"
cat content/docs/web/meta.json 2>/dev/null || echo "web/meta.json not found"
echo ""
echo "Vue framework pages:"
cat content/docs/vue/meta.json 2>/dev/null || echo "vue/meta.json not found"Length of output: 323
Let me search for "advanced-usage" more broadly and check if it's a directory or exists elsewhere:
🏁 Script executed:
#!/bin/bash
# Search for advanced-usage in codebase and check directory structure
echo "=== Search for 'advanced-usage' string anywhere ==="
rg "advanced-usage" content/docs/
echo ""
echo "=== Check for advanced-usage directory ==="
find content/docs/react-native -name "*advanced*" -o -name "*usage*"
echo ""
echo "=== List all directories in react-native ==="
find content/docs/react-native -maxdepth 1 -type dLength of output: 258
Remove "advanced-usage" from pages array or create the missing page.
The advanced-usage page referenced in the pages array does not exist in the repository. Search results show this string appears only in react-native/meta.json and no corresponding .mdx file or directory exists. The other three pages (installation, install, troubleshooting) are correctly configured, but advanced-usage is a broken reference that will cause navigation failures.
🤖 Prompt for AI Agents
In content/docs/react-native/meta.json around lines 3 to 8, the pages array
includes "advanced-usage" which has no corresponding .mdx page in the repo;
either remove "advanced-usage" from the array or create the missing page file at
the expected path (e.g., content/docs/react-native/advanced-usage.mdx) with
appropriate frontmatter and content; after making the change, run the docs build
or navigation check to confirm the broken reference is resolved.
Description
Testing (ignore for documentation update)
Type of change
Checklist:
Additional Notes:
Summary by CodeRabbit
Release Notes
Documentation
New Features