Skip to content
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.

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

chore: fix few outdated things in docs & readme #18920

Merged
merged 1 commit into from
Feb 21, 2024

Conversation

siddarthkay
Copy link
Contributor

@siddarthkay siddarthkay commented Feb 20, 2024

Summary

In this PR we brings docs upto speed on a few things :

  • remove technical doc link from old website
  • update steps on how to build the app for physical iOS device
  • update steps on new workflow to build app without needing make run-metro
  • remove info about disabling hermes
  • Add information about running integration and unit tests separately
  • update getting started steps

Review

To review open these links in a new window

status: ready

Copy link
Member

@flexsurfer flexsurfer left a comment

Choose a reason for hiding this comment

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

thanks

README.md Show resolved Hide resolved
doc/starting-guide.md Outdated Show resolved Hide resolved
@status-im-auto
Copy link
Member

status-im-auto commented Feb 20, 2024

Jenkins Builds

Click to see older builds (7)
Commit #️⃣ Finished (UTC) Duration Platform Result
✔️ 5425c9d #3 2024-02-20 14:16:25 ~5 min tests 📄log
✔️ 5425c9d #3 2024-02-20 14:17:22 ~6 min android 🤖apk 📲
✔️ 5425c9d #3 2024-02-20 14:17:26 ~6 min ios 📱ipa 📲
✔️ 5425c9d #3 2024-02-20 14:18:32 ~7 min android-e2e 🤖apk 📲
✔️ 1c6ad17 #4 2024-02-21 16:20:27 ~10 min android 🤖apk 📲
✔️ 1c6ad17 #4 2024-02-21 16:20:51 ~11 min android-e2e 🤖apk 📲
✔️ 1c6ad17 #4 2024-02-21 16:21:45 ~12 min tests 📄log
Commit #️⃣ Finished (UTC) Duration Platform Result
✔️ 3f47db8 #5 2024-02-21 16:27:45 ~5 min tests 📄log
✔️ 3f47db8 #5 2024-02-21 16:29:59 ~7 min android 🤖apk 📲
✔️ 3f47db8 #5 2024-02-21 16:30:18 ~8 min android-e2e 🤖apk 📲
✔️ 3f47db8 #5 2024-02-21 16:31:23 ~9 min ios 📱ipa 📲
✔️ fbf8a1d #6 2024-02-21 18:40:27 ~4 min tests 📄log
✔️ fbf8a1d #6 2024-02-21 18:42:46 ~7 min android-e2e 🤖apk 📲
✔️ fbf8a1d #6 2024-02-21 18:42:53 ~7 min android 🤖apk 📲
✔️ fbf8a1d #6 2024-02-21 18:43:41 ~8 min ios 📱ipa 📲

doc/testing.md Outdated Show resolved Hide resolved
doc/testing.md Outdated Show resolved Hide resolved
doc/starting-guide.md Outdated Show resolved Hide resolved
Copy link
Member

@jakubgs jakubgs left a comment

Choose a reason for hiding this comment

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

Always good to update docs.

Copy link
Contributor

@ilmotta ilmotta left a comment

Choose a reason for hiding this comment

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

Thank you! Always important work. Apart from a few formatting details (https://github.com/status-im/status-mobile/pull/18920/files#r1496194438), LGTM.

doc/testing.md Outdated Show resolved Hide resolved
In this commit we brings docs upto speed on a few things :
- remove technical doc link from old website
- update steps on how to build the app for physical iOS device
- update steps on new workflow to build app without needing `make run-metro`
- remove info about disabling `hermes`
- Add information about running integration and unit tests separately
- update getting started steps
@siddarthkay siddarthkay merged commit 3c12ac8 into develop Feb 21, 2024
6 checks passed
@siddarthkay siddarthkay deleted the update-docs-and-main-readme branch February 21, 2024 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Archived in project
Development

Successfully merging this pull request may close these issues.

9 participants