From 91ce6bc1535fd5ad5c524150c185cc0d3e3709dd Mon Sep 17 00:00:00 2001 From: Riccardo Date: Wed, 21 Sep 2022 12:52:34 +0100 Subject: [PATCH] fix: Improve wording for iOS getting started (#3334) --- docs/_getting-started-macos-ios.md | 10 +++++++--- .../backward-compatibility-fabric-components.md | 4 +++- .../backward-compatibility-turbomodules.md | 4 +++- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/_getting-started-macos-ios.md b/docs/_getting-started-macos-ios.md index 840b38b5803..7359e734983 100644 --- a/docs/_getting-started-macos-ios.md +++ b/docs/_getting-started-macos-ios.md @@ -21,6 +21,8 @@ If you have already installed Node on your system, make sure it is Node 14 or ne ### Ruby +[Ruby](https://www.ruby-lang.org/en/) is a general-purpose programming language. React Native uses in some scripts related to the iOS dependency management. As every programming language, there are different versions of Ruby that have been developed during the years. + React Native uses a `.ruby-version` file to make sure that your version of Ruby is aligned with what is needed. Currently, macOS 12.5.1 is shipped with Ruby 2.6.8, which is **not** what is required by React Native. Our suggestion is to install a Ruby version manager and to install the proper version of Ruby in your system. Some common Ruby version manager are: @@ -38,9 +40,11 @@ ruby --version React Native uses [this version](https://github.com/facebook/react-native/blob/main/template/_ruby-version) of Ruby. You can also find which version your specific project needs in the `.ruby-version` file at root of your RN project. -### Bundler +### Ruby's Bundler + +Ruby uses the concept of **gems** to handle its own dependencies. You can think of a gem as a package in NPM, a formula in Homebrew or a single pod in Cocoapods. -[Bundler](https://bundler.io/) is a Ruby gem that helps managing the Ruby dependencies of your project. We need Ruby to install Cocoapods and using Bundler will make sure that all the dependencies are aligned and that the project works properly. +Ruby's [Bundler](https://bundler.io/) is a Ruby gem that helps managing the Ruby dependencies of your project. We need Ruby to install Cocoapods and using Bundler will make sure that all the dependencies are aligned and that the project works properly. If you want to learn more about why we need this tool, you can read [this article](https://bundler.io/guides/rationale.html#bundlers-purpose-and-rationale). @@ -62,7 +66,7 @@ To install a simulator, open Xcode > Preferences... and select #### CocoaPods -[CocoaPods](https://cocoapods.org/) is built with Ruby and it will be installable with the default Ruby available on macOS. +[CocoaPods](https://cocoapods.org/) is one of the dependency management system available for iOS. It is built with Ruby and you can install it using the version of Ruby you configured with in the previous steps. For more information, please visit [CocoaPods Getting Started guide](https://guides.cocoapods.org/using/getting-started.html). diff --git a/docs/the-new-architecture/backward-compatibility-fabric-components.md b/docs/the-new-architecture/backward-compatibility-fabric-components.md index 21e65220483..8eb6b47d203 100644 --- a/docs/the-new-architecture/backward-compatibility-fabric-components.md +++ b/docs/the-new-architecture/backward-compatibility-fabric-components.md @@ -24,11 +24,13 @@ Creating a backward compatible Fabric Native Component lets your users continue 1. Uniform the JavaScript API so that your user code won't need changes. :::info + For the sake of this guide we're going to use the following **terminology**: - **Legacy Native Components** - To refer to Components which are running on the old React Native architecture. - **Fabric Native Components** - To refer to Components which have been adapted to work well with the New Native Renderer, Fabric. For brevity you might find them referred as **Fabric Components**. - ::: + +::: diff --git a/docs/the-new-architecture/backward-compatibility-turbomodules.md b/docs/the-new-architecture/backward-compatibility-turbomodules.md index 2cdc68f1608..fbc2e89a063 100644 --- a/docs/the-new-architecture/backward-compatibility-turbomodules.md +++ b/docs/the-new-architecture/backward-compatibility-turbomodules.md @@ -24,11 +24,13 @@ Creating a backward compatible TurboModule lets your users continue to leverage 1. Uniform the JavaScript API so that your user code won't need changes. :::info + For the sake of this guide we're going to use the following **terminology**: - **Legacy Native Modules** - To refer to Modules which are running on the old React Native architecture. - **Turbo Native Modules** - To refer to Modules which have been adapted to work well with the New Native Module System. For brevity you might find them referred as **Turbo Modules**. - ::: + +:::