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

DOCS: Describe SAF protocol for Android #4760

Merged
merged 1 commit into from Mar 3, 2023
Merged

Conversation

sev-
Copy link
Member

@sev- sev- commented Mar 2, 2023

Described the new SAF workflow for Android. Thanks to @lephilousophe for the screenshots.

Copy link
Contributor

@antoniou79 antoniou79 left a comment

Choose a reason for hiding this comment

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

I've added a couple of comments to change the example parent folder's name from "myGames" to "ScummVMgames" to match the screenshots.

Also, in the same page (android.rst) there is a "Note" in the "What you'll need" section that reads ".. note::

ScummVM has been tested to work up to Android 10. Currently there are some file browsing limitations with Android 11. The ScummVM team are working to resolve these."

This can be removed or reduced to:
".. note::

ScummVM has been tested to work up to Android 12."

And also there is a "Known issues" section in the bottom where the first bullet can be removed.
This bullet reads:
"- On some newer devices, there is an issue if the saved path is outside the app's internal (or external) storage. The ScummVM team is currently working on a fix."
It can be removed.

doc/docportal/other_platforms/android.rst Outdated Show resolved Hide resolved
doc/docportal/other_platforms/android.rst Outdated Show resolved Hide resolved
@sev-
Copy link
Member Author

sev- commented Mar 3, 2023

@antoniou79 I addressed the issues. Please review.

Copy link
Member

@lephilousophe lephilousophe left a comment

Choose a reason for hiding this comment

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

Looks good to me.
It's really centred around migration from an old version and not for newcomers but maybe the UI is simple enough to not need dedicated instructions.

doc/docportal/other_platforms/android.rst Outdated Show resolved Hide resolved
doc/docportal/other_platforms/android.rst Outdated Show resolved Hide resolved
@sev- sev- force-pushed the documentation-saf branch 5 times, most recently from 7b8941e to 9f4f5f1 Compare March 3, 2023 20:01
@sev- sev- merged commit e9761ca into scummvm:master Mar 3, 2023
5 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants