Skip to content

[PM-28512] Update iOS Getting Started guide to remove explicit versions #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fedemkr merged 1 commit into from
Nov 20, 2025
+17 −3
Merged

[PM-28512] Update iOS Getting Started guide to remove explicit versions #711

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions docs/getting-started/mobile/ios/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ sidebar_position: 1

## Requirements

1. [Xcode](https://developer.apple.com/xcode/) (version 16.3)
2. An iPhone 16 Pro simulator (iOS 18.1) set up
1. [Xcode](https://developer.apple.com/xcode/) (using
[this](https://github.com/bitwarden/ios/blob/main/.xcode-version) version)
2. iOS & watchOS simulator runtimes installed
Copy link
Contributor

@KatherineInCode KatherineInCode Nov 20, 2025

Choose a reason for hiding this comment

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

🤔 I generally think of ampersands as being too casual for usage in sentences like this. I'd prefer this (and the one on the line before) to be explicit "and"s, but that's something of a personal style thing.

Copy link
Member Author

@fedemkr fedemkr Nov 20, 2025

Choose a reason for hiding this comment

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

@KatherineInCode Thanks for raising this, added the changes in #631

3. An iPhone simulator set up (check
[model](https://github.com/bitwarden/ios/blob/main/.test-simulator-device-name) &
[version](https://github.com/bitwarden/ios/blob/main/.test-simulator-ios-version) to make/run
snapshots)

## Setup

Expand Down Expand Up @@ -56,6 +61,15 @@ sidebar_position: 1
$ cp Scripts/post-checkout .git/hooks/
```

Also, if the Xcode version installed mismatches the expected one you will receive a warning when
the script finishes like this one which can help troubleshooting.
Copy link

@claude claude bot Nov 20, 2025

Choose a reason for hiding this comment

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

⚠️ Minor grammar issue: This sentence needs grammatical correction.

Suggested change
the script finishes like this one which can help troubleshooting.
Also, if the Xcode version installed mismatches the expected one, you will receive a warning when
the script finishes like this one, which can help troubleshooting:

Changes:

  • Added comma after "expected one" (compound sentence structure)
  • Added comma before "which" (non-restrictive clause)
  • Added colon after "troubleshooting" (introduces the example that follows)

Copy link
Contributor

@KatherineInCode KatherineInCode Nov 20, 2025

Choose a reason for hiding this comment

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

Claude is half-correct here; there should be more commas, though I would actually break it up into two sentences:

Also, if the installed Xcode version does not match the expected version, you will receive a warning, which can help with troubleshooting. That warning looks like this:

I also changed "mismatch" to "do not match" because it sounds slightly better to my ear, but I'm not wedded to that.

However, "the script finishes like this one" is a pretty not-great dangling modifier IMO; Claude is incorrect, and there should be another comma between "finishes" and "like".


```
🟡 Xcode version mismatch!
Required version: 26.0.1
Copy link

@claude claude bot Nov 20, 2025

Choose a reason for hiding this comment

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

💭 Sample version value concern: The example shows "Required version: 26.0.1" which appears unrealistic (Xcode 26 doesn't exist yet - current is 16.x).

Consider using a version number that matches reality to avoid confusion:

   🟡 Xcode version mismatch!
   Required version: 16.0.1
   Current version: 16.4

This helps developers understand what actual version numbers look like and reduces potential confusion.

Current version: 16.4
```

4. Install [fastlane](https://docs.fastlane.tools/) for automated package deployments:

> **Note** We manage non-system Ruby installations with `rbenv` as homebrew tends to break the
Expand Down Expand Up @@ -107,7 +121,7 @@ sidebar_position: 1

### Run the app

1. Open the project in Xcode 16.3+.
1. Open the project in Xcode.
2. Run the app in the Simulator with the `Bitwarden` target for the Password Manager app or
`Authenticator` for the Authenticator app.

Expand Down
Loading