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

[PM-7253] Added mobile native docs #400

Merged
merged 18 commits into from
Aug 13, 2024
Merged

Conversation

fedemkr
Copy link
Member

@fedemkr fedemkr commented Jul 31, 2024

🎟️ Tracking

PM-7253

📔 Objective

Update docs for the mobile native applications. Includes mobile native architecture and getting started with iOS.

Notes:
Getting started for Android will be handled in a different PR.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@fedemkr fedemkr requested review from a team as code owners July 31, 2024 17:53
@fedemkr fedemkr changed the title [PM-7253] Added mobile native docs. [PM-7253] Added mobile native docs Jul 31, 2024
Copy link

github-actions bot commented Jul 31, 2024

Logo
Checkmarx One – Scan Summary & Details14cf3861-9aac-4f0f-ab36-12d02d1c79db

No New Or Fixed Issues Found

Copy link

cloudflare-workers-and-pages bot commented Jul 31, 2024

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0aaa2a7
Status: ✅  Deploy successful!
Preview URL: https://225067c6.contributing-docs.pages.dev
Branch Preview URL: https://mobiletf-pm-7253-mobile-nati.contributing-docs.pages.dev

View logs

@fedemkr fedemkr requested a review from KatherineInCode July 31, 2024 19:33
Copy link
Contributor

@withinfocus withinfocus left a comment

Choose a reason for hiding this comment

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

Big PR so I did a quick scan. I stopped commenting on the headers -- please get all of them.

docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
[DataState](https://github.com/bitwarden/android/blob/main/app/src/main/java/com/x8bit/bitwarden/data/platform/repository/model/DataState.kt)
wrapper.

### Note on Dependency Injection
Copy link
Contributor

Choose a reason for hiding this comment

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

🎨 Make this an actual note or info block where appropriate.

docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
@@ -4,8 +4,92 @@ sidebar_position: 1

# iOS
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ Is there not an Android version of this guide available?

Copy link
Member Author

@fedemkr fedemkr Aug 7, 2024

Choose a reason for hiding this comment

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

It's but we discussed it in Slack and it's going to be handled in a different PR by @patrick-bitwarden so we keep author attribution for the docs. Or he could add it directly in this PR if you think is better instead of splitting it.

@withinfocus withinfocus requested a review from SaintPatrck August 1, 2024 16:51
@fedemkr fedemkr requested a review from withinfocus August 8, 2024 19:50
Copy link
Contributor

@withinfocus withinfocus left a comment

Choose a reason for hiding this comment

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

Enough ⛏️s from me -- ship it!

package.json Outdated Show resolved Hide resolved
withinfocus
withinfocus previously approved these changes Aug 13, 2024
Base automatically changed from mobiletf/pm-7516/mobile-restructure to main August 13, 2024 19:44
@fedemkr fedemkr dismissed stale reviews from withinfocus and KatherineInCode August 13, 2024 19:44

The base branch was changed.

# Conflicts:
#	docs/architecture/mobile-clients/android/index.md
#	docs/architecture/mobile-clients/ios/index.md
#	docs/architecture/mobile-clients/net-maui-legacy/index.mdx
#	docs/architecture/mobile-clients/net-maui-legacy/overview.md
#	docs/architecture/mobile-clients/net-maui-legacy/watchOS.md
#	docs/getting-started/mobile/android/index.md
#	docs/getting-started/mobile/ios/index.md
#	docs/getting-started/mobile/net-maui-legacy/android/index.md
#	docs/getting-started/mobile/net-maui-legacy/index.md
#	docs/getting-started/mobile/net-maui-legacy/ios/index.mdx
#	docs/getting-started/mobile/net-maui-legacy/watchos/index.mdx
Copy link
Contributor

@withinfocus withinfocus left a comment

Choose a reason for hiding this comment

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

Just a rebase.

@fedemkr fedemkr merged commit b781ea4 into main Aug 13, 2024
7 checks passed
@fedemkr fedemkr deleted the mobiletf/pm-7253/mobile-native-docs branch August 13, 2024 20:10
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