Skip to content

docs: housekeeping#273

Merged
artus9033 merged 5 commits intomainfrom
docs/update-docs-v3
Mar 14, 2026
Merged

docs: housekeeping#273
artus9033 merged 5 commits intomainfrom
docs/update-docs-v3

Conversation

@artus9033
Copy link
Collaborator

Summary

This PR updates the docs to match the current code state. Additionally, docs files were formatted and compatibility table has been updated (between RN 0.83 & Brownfield v3).

Test plan

@artus9033 artus9033 requested a review from hurali97 March 14, 2026 12:03
@artus9033 artus9033 self-assigned this Mar 14, 2026
Copilot AI review requested due to automatic review settings March 14, 2026 12:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR primarily updates the documentation to align with current CLI commands/output paths and the latest React Native Brownfield APIs, plus a small comment fix in the iOS packaging command.

Changes:

  • Update docs to reflect current CLI commands (package:android, publish:android) and iOS artifact output location (ios/.brownfield/package/build).
  • Refresh API reference docs across Swift/Obj-C/Java/Kotlin/JS (including documenting app-delegate forwarding on iOS).
  • Minor cleanup/typo fixes in docs and CLI source comments.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
packages/cli/src/brownfield/commands/packageIos.ts Fixes a comment typo for Brownie.xcframework.
docs/docs/docs/guides/troubleshooting.mdx Whitespace/formatting cleanup in troubleshooting text.
docs/docs/docs/getting-started/quick-start.mdx Updates headings and command table to current CLI command names.
docs/docs/docs/getting-started/ios.mdx Updates documented iOS packaging output directory.
docs/docs/docs/getting-started/introduction.mdx Updates the RN compatibility table to include 0.83.x.
docs/docs/docs/contributing.md Removes trailing blank line.
docs/docs/docs/cli/brownfield.mdx Updates default build/output paths and lists produced XCFrameworks.
docs/docs/docs/api-reference/react-native-brownfield/swift.mdx Updates Swift API reference; adds application(_:didFinishLaunchingWithOptions:) section.
docs/docs/docs/api-reference/react-native-brownfield/objective-c.mdx Updates Obj-C API reference to match current properties and signatures.
docs/docs/docs/api-reference/react-native-brownfield/kotlin.mdx Updates Kotlin createView docs/examples to match current signature (no context param).
docs/docs/docs/api-reference/react-native-brownfield/javascript.mdx Updates popToNative signature docs to optional param.
docs/docs/docs/api-reference/react-native-brownfield/java.mdx Updates Java createView docs/examples to match current signature (no context param).
docs/docs/docs/api-reference/brownie/getting-started.mdx Updates iOS output directory and framework list for Brownie guide.
docs/docs/docs/api-reference/brownie/codegen.mdx Removes an extra blank line.
docs/docs/docs/api-reference/brownfield-navigation.mdx/javascript-usage.mdx Updates navigation codegen command to npx brownfield navigation:codegen.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@thymikee
Copy link
Member

Could you maybe also tackle this? #269

@artus9033
Copy link
Collaborator Author

Sure!

@artus9033 artus9033 requested a review from thymikee March 14, 2026 13:21
Copy link
Member

@thymikee thymikee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you make sure to update the skills in a followup PR to callstackincubator/agent-skills if feasible?

@artus9033
Copy link
Collaborator Author

Yes, I will follow up with a PR there

@artus9033 artus9033 merged commit 239f6cb into main Mar 14, 2026
8 of 9 checks passed
@artus9033 artus9033 deleted the docs/update-docs-v3 branch March 14, 2026 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants