Skip to content

📝 (docs): Update README#1372

Draft
pvautherin-ledger wants to merge 2 commits intodevelopfrom
docs/update-onboarding
Draft

📝 (docs): Update README#1372
pvautherin-ledger wants to merge 2 commits intodevelopfrom
docs/update-onboarding

Conversation

@pvautherin-ledger
Copy link
Copy Markdown

@pvautherin-ledger pvautherin-ledger commented Mar 18, 2026 •
edited
Loading

📝 Description

Small updates to the README file (NO JIRA / No changeset)

Page preview here.

✅ Checklist

Pull Requests must pass CI checks and undergo code review. Set the PR as Draft if it is not yet ready for review.

  • Covered by automatic tests
  • Changeset is provided
  • Documentation is up-to-date
  • Impact of the changes:
    • list of the changes

🧐 Checklist for the PR Reviewers

  • The code aligns with the requirements described in the linked JIRA or GitHub issue.
  • The PR description clearly documents the changes made and explains any technical trade-offs or design decisions.
  • There are no undocumented trade-offs, technical debt, or maintainability issues.
  • The PR has been tested thoroughly, and any potential edge cases have been considered and handled.
  • Any new dependencies have been justified and documented.

@pvautherin-ledger pvautherin-ledger requested a review from a team as a code owner March 18, 2026 15:47
Copilot AI review requested due to automatic review settings March 18, 2026 15:47
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 18, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
device-sdk-ts-sample Ready Ready Preview, Comment Mar 18, 2026 3:47pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
doc-device-management-kit Ignored Ignored Mar 18, 2026 3:47pm

Request Review

Copilot AI reviewed Mar 18, 2026
View reviewed changes
Copy link
Copy Markdown
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

Updates the mobile app README to reflect the repository’s current React Native setup guidance and preferred package manager usage.

Changes:

  • Updates the React Native environment setup link and warning text.
  • Replaces npm/yarn command examples with pnpm equivalents for start/android/ios.

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

apps/mobile/README.md
Comment on lines 19 to 25
Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:

### For Android

```bash
# using npm
npm run android

# OR using Yarn
yarn android
pnpm android
```
apps/mobile/README.md
# Getting Started

>**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
⚠️ **IMPORTANT**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/set-up-your-environment) instructions on both iOS and Android targets before proceeding.
apps/mobile/README.md
Comment on lines 11 to 15
To start Metro, run the following command from the _root_ of your React Native project:

```bash
# using npm
npm start

# OR using Yarn
yarn start
pnpm start
```
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 18, 2026

Fails
🚫

node failed.

Danger Check Results

Failures

🚫

Please fix the PR branch name to match the convention, see CONTRIBUTING.md.

Wrong branch name: docs/update-onboarding

ℹ️ Regex to match: /^(release|chore\/backmerge(-.+){0,}|(feature|feat|bugfix|bug|hotfix|fix|support|chore|core|doc|refacto|refactor)\/((dsdk|live)-[0-9]+|no-issue|NOISSUE|issue-[0-9]+)-.+)/i

  • Rules:
    • Must start with a type (feature, feat, bugfix, bug, hotfix, fix, support, chore, core, doc, refacto, refactor)
    • Followed by a SLASH ("/")
    • Followed by a JIRA issue number (DSDK-1234) (LIVE-1234) or "no-issue" or "issue-1234" if fixing a Github issue
    • Followed by a DASH ("-")
    • Followed by a description

ℹ️ Example: feat/dsdk-1234-my-feature

🚫

Please fix the PR title to match the convention, see CONTRIBUTING.md.

Wrong PR title: 📝 (docs): Update README

ℹ️ Regex to match: /^.+ \(([a-z]+\-?){1,}\) \[(DSDK-[0-9]+|LIVE-[0-9]+|NO-ISSUE|ISSUE-[0-9]+)\]: [A-Z].*/

  • Rules:
    • Must start with a word (usually an emoji)
    • Followed by a SPACE
    • Followed by a scope in parentheses and in LOWERCASE
    • Followed by a SPACE
    • Followed by a JIRA issue number or NO-ISSUE or ISSUE- in [brackets] (uppercase)
    • Followed by a colon (":") and a SPACE
    • Followed by a Capitalized message

ℹ️ Example: ✨ (scope) [DSDK-1234]: My feature

Messages

⚠️

No changeset file found. Please make sure this is intended or add a changeset file.

Log

Details 
PR Actor: pvautherin-ledger
danger-results://tmp/danger-results-51468a10.json

Generated by 🚫 dangerJS against d264391

@pvautherin-ledger pvautherin-ledger marked this pull request as draft March 19, 2026 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@pvautherin-ledger pvautherin-ledger

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pvautherin-ledger