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

[BD-3275] Cleaning up Swift, Android, Web docs #8273

Open
wants to merge 56 commits into
base: develop
Choose a base branch
from

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Oct 22, 2024

Why are you making this change? (required)

Cleaning up the Swift, Android, and Web docs as a part of the developer detangle project.

How to review (for reviewers)

This PR touches a lot of files. To help get these changes merged in a timely manner, here are some things to keep in mind:

  1. Ignore broken links: Please ignore broken links. Most will be wrong/broken as I will be fixing this while you review the content.
  2. Focus on information architecture: The goal of this PR is to improve the information architecture of Swift, Android, Web, not necessarily the individual lines and paragraphs on each page. That will come in later PRs. As a reviewer, focus on the information flow, i.e. are the prereqs accurate, are the steps properly named and in the correct order, etc. Keep in mind, I did have to update some individual lines/paragraphs in order to align with architecture changes I made.
  3. Its ok to make make small changes yourself: You definitely don't have to, but don't feel like you can't make quick fixes directly to the pages (like typos or slight miss-wordings etc.).
  4. Use GitHub suggestions: If applicable, use GitHub suggestions when leaving feedback on a line so I can easily merge your requested changes. Here's the syntax:
```suggestion
Add your suggestion here
```

Related PRs, issues, or features (optional)

  • N/A

Feature release date (optional)

  • N/A

Contributor checklist

  • I confirm that my PR meets the following:
    • I signed the Contribution License Agreement (CLA).
    • My style and voice follows the Braze Style Guide.
    • My content contains correct spelling and grammar.
    • All links are working correctly.
    • If I renamed or moved a file or directory, I set up URL redirects for each file.
    • If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see Updating an image).
    • If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal.

Submitting for review

If your PR meets the above requirements, select Ready for review, then add a reviewer:

  • Non-Braze contributors: Add braze-inc/docs-team as the reviewer.
  • Braze employees: Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the tech writer assigned to your specific vertical. If you're not sure which tech writer to add, you can add braze-inc/docs-team instead.

Thanks for contributing! We look forward to reading your work.

@cla-bot cla-bot bot added the cla-signed label Oct 22, 2024
Copy link

vercel bot commented Oct 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
braze-docs-ko ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 10:45pm
braze-docs-pt-br ⬜️ Ignored (Inspect) Visit Preview Dec 9, 2024 10:45pm

@internetisaiah internetisaiah changed the title [BD-3275] Cleaning up Swift docs [BD-3275] Cleaning up Swift, Android, Web docs Oct 23, 2024
@internetisaiah
Copy link
Contributor Author

Note: FireOS needs to be its own section, some of the content in Android section is a holdover from a prior implementation. You'll use includes to do this. Finish the Android section first as it will be easier to set up FireOS after that.

@internetisaiah
Copy link
Contributor Author

Double-checked all files against current version of develop. All files/lines are still in sync.


### Disable in-app message TalkBack

In adherence to the [Android accessibility guidelines](https://developer.android.com/guide/topics/ui/accessibility), the Braze Android SDK offers Android Talkback by default. However, to ensure end-user privacy, you may want to disable Talkback so in-app messages are not read automatically.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@davidbielik , i tweaked the phrasing from the original doc. is this accurate? am i correct in using the word "automatic"? or is that incorrect?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Exclusive mode doesn't change TalkBack being enabled or not, it just changes if other screen elements are read. For example, if you have an In-App message appear, you may want to not read the title bar of the app, the navigation of the app, you want it to just read the IAM.

You know when an IAM comes up and sometimes the background is dimmed so you don't look at it? This is like the audio equivalent of that.

@internetisaiah
Copy link
Contributor Author

@cla-bot check

Copy link

cla-bot bot commented Dec 20, 2024

The cla-bot has been summoned, and re-checked this pull request!

@internetisaiah
Copy link
Contributor Author

the new bdocs command ulinks has been finalized in #8652 . this can now be used to mass update all the links across these pages using the redirects i set up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants