Skip to content

docs: update repository and npm READMEs for 2.0.7 - #769

Merged
CedricGuillemet merged 5 commits into
masterfrom
docs/update-readmes
Oct 16, 2026
Merged

CedricGuillemet merged 5 commits into
masterfrom
docs/update-readmes

Conversation

@CedricGuillemet

@CedricGuillemet CedricGuillemet commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Describe the change

Update the repository README and npm package README source for 2.0.7, identifying it as the latest stable release in preparation for publication.

  • Add the 2.0.7 installation command, compatibility rows, and Babylon Native source pin f4d9efbeeabcfec24105373b99e54fe147669fc1. Document the native/JsRuntimeHost dependency update and removal of obsolete minz links already implemented on master; Babylon.js and React Native baselines remain unchanged from 2.0.6.
  • Preserve historical 2.0.x peer ranges and native source pins. Record resolved Playground versions rather than manifest lower bounds: 2.0.5 locks React Native Windows 0.81.21; 2.0.6 and 2.0.7 use React Native 0.81.6 with React Native Windows 0.81.35. Explain the NuGet-aligned Windows pin and the ^0.81.4 manifest range.
  • Refresh Android ABI/ARCore/Kotlin guidance, iOS 16 and CMake configuration, camera permissions, and experimental Windows integration.
  • Correct contributor setup, toolchains, Playground launching, packaging, and debugging guidance. Use BRNPlayground.xcworkspace with the Playground scheme for iOS instead of the CLI-selected workspace, and fix the antiAliasing example.

The npm README is copied from Modules/@babylonjs/react-native/README.md during packaging and reaches npm with the next package publication. This PR changes only the two READMEs; it does not change runtime code or package versions.

No linked issue.

Screenshots

N/A — documentation-only changes.

Documentation

Have you updated the documentation to reflect your changes? (Yes or N/A)

Yes — updated README.md and Modules/@babylonjs/react-native/README.md.

Testing

Have you tested the final iteration of your changes? (Yes or N/A or I need help testing on [Android|iOS|Windows])

N/A for Playground testing — documentation-only changes.

  • git diff --check origin/master...HEAD — passed.
  • node - (read-only README assertions supplied through stdin) — passed: Markdown fences, 14 local links/anchors, latest-version wording, eight Babylon Native source pins and Babylon.js peer ranges, resolved Playground versions for 2.0.5–2.0.7, corrected iOS workspace instructions, and the antiAliasing example. Historical entries were checked against release tags; the 2.0.7 entry was checked against origin/master ahead of release.

Native builds, TypeScript checks, and manual Android/iOS/Windows device testing were not run.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8d68c500-a3eb-4b2e-8726-17b7f4073d8f
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8d68c500-a3eb-4b2e-8726-17b7f4073d8f
@CedricGuillemet
CedricGuillemet requested a balanced review from Copilot October 13, 2026 08:24
@CedricGuillemet
CedricGuillemet marked this pull request as ready for review October 13, 2026 08:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation is consistent with the repository configuration, release tags, package metadata, and implementation.

0 open findings

What changed in this PR

Updates repository and npm-facing documentation for release 2.0.6 and current platform configuration.

Changes:

  • Documents supported versions, dependencies, and native source pins.
  • Refreshes platform setup, build, packaging, permissions, and troubleshooting guidance.
  • Corrects API examples and Windows integration instructions.
File Description
README.md Updates contributor, platform, testing, and packaging guidance.
Modules/​@babylonjs/​react-native/​README.md Updates package installation, compatibility, configuration, and API documentation.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread Modules/@babylonjs/react-native/README.md Outdated
CedricGuillemet and others added 3 commits October 13, 2026 17:30
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8d68c500-a3eb-4b2e-8726-17b7f4073d8f
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8d68c500-a3eb-4b2e-8726-17b7f4073d8f
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 8d68c500-a3eb-4b2e-8726-17b7f4073d8f
@CedricGuillemet CedricGuillemet changed the title docs: update repository and npm READMEs for 2.0.6 docs: update repository and npm READMEs for 2.0.7 Oct 16, 2026
@CedricGuillemet
CedricGuillemet merged commit 721b33f into master Oct 16, 2026
6 checks passed
@CedricGuillemet
CedricGuillemet deleted the docs/update-readmes branch October 16, 2026 07:00
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