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-7516] Restructure mobile docs for new native apps #399

Merged
merged 10 commits into from
Aug 13, 2024

Conversation

fedemkr
Copy link
Member

@fedemkr fedemkr commented Jul 31, 2024

🎟️ Tracking

PM-7516

📔 Objective

Update the docs to include both the native app and the legacy .NET MAUI app.

Now the structure looks like:

  • Mobile
    • Android
    • iOS
    • .NET MAUI (legacy)

Notes:
This PR only covers restructuring the folders. I'll open a new PR for the content of the new native docs, right now they only have a short description so the pages are not empty.

⏰ 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 15:43
Copy link

github-actions bot commented Jul 31, 2024

Logo
Checkmarx One – Scan Summary & Details421f86f7-f043-4302-a6c0-fe5dde27c105

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: ef3c6e7
Status: ✅  Deploy successful!
Preview URL: https://cef61786.contributing-docs.pages.dev
Branch Preview URL: https://mobiletf-pm-7516-mobile-rest.contributing-docs.pages.dev

View logs

@withinfocus withinfocus changed the title [PM-7516] Restructure mobile docs for new native apps. [PM-7516] Restructure mobile docs for new native apps Aug 13, 2024
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.

Please copy my suggestions wherever relevant; I didn't want to keep repeating comments.

docs/architecture/mobile-clients/android/index.md Outdated Show resolved Hide resolved
Comment on lines 14 to 19
## Compatibility

- **Minimum SDK**: 28
- **Target SDK**: 34
- **Device Types Supported**: Phone and Tablet
- **Orientations Supported**: Portrait and Landscape
Copy link
Contributor

Choose a reason for hiding this comment

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

🌱 This is likely to change somewhat frequently over time. The repos have a lot of this already too. Can we omit it here?

docs/architecture/mobile-clients/net-maui-legacy/index.mdx Outdated Show resolved Hide resolved
docs/architecture/mobile-clients/net-maui-legacy/index.mdx Outdated Show resolved Hide resolved
docs/architecture/mobile-clients/net-maui-legacy/index.mdx Outdated Show resolved Hide resolved
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.

Looks great. I didn't review the big diff assuming it was just a move.

[Git repository](https://github.com/bitwarden/mobile).
:::warning Legacy

This represents the **legacy** mobile app architecture done in .NET MAUI.
Copy link
Contributor

Choose a reason for hiding this comment

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

⛏️ "done" may be confusing to non-English speakers but this works well enough!

@fedemkr fedemkr merged commit d1f0edf into main Aug 13, 2024
7 checks passed
@fedemkr fedemkr deleted the mobiletf/pm-7516/mobile-restructure branch August 13, 2024 19:44
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.

2 participants