Made some changes for better readabilty, and understanding of the tex… #288
Conversation
…t to avoid any confusion for the contributors.
There was a problem hiding this comment.
Thanks for working on these! @wbrunette can you double check the install code changes?
src/app-designer-prereqs.rst
Outdated
| @@ -37,7 +37,7 @@ You must install the following software on your computer in order to use Applica | |||
|
|
|||
| .. warning:: | |||
|
|
|||
| Android Studio is not supported on the Windows Linux subsystem, so you will not be able to run Application Designer if you are using it. | |||
| Android Studio is not supported on the Windows Subsystem for Linux (WSL). so you will not be able to run Application Designer if you are using it. | |||
There was a problem hiding this comment.
period after (WSL) should be a comma. Is the acronym needed? If not used elsewhere, can skip here.
There was a problem hiding this comment.
keeping WSL is okay helps when reading other documentation as often referred to as WSL
There was a problem hiding this comment.
Need to fix with the slashes with tabs
incorrect on mac/unix slashes go other way and it's under the mac section.
Like this part of the documentation: https://docs.odk-x.org/docs-tech-guide/#before-you-begin
notice the "bash" and "PowerShell" tabs to explain the difference
src/app-designer-prereqs.rst
Outdated
| @@ -37,7 +37,7 @@ You must install the following software on your computer in order to use Applica | |||
|
|
|||
| .. warning:: | |||
|
|
|||
| Android Studio is not supported on the Windows Linux subsystem, so you will not be able to run Application Designer if you are using it. | |||
| Android Studio is not supported on the Windows Subsystem for Linux (WSL). so you will not be able to run Application Designer if you are using it. | |||
There was a problem hiding this comment.
keeping WSL is okay helps when reading other documentation as often referred to as WSL
src/app-designer-prereqs.rst
Outdated
| @@ -178,8 +178,8 @@ To install the Android SDK: | |||
|
|
|||
| .. code-block:: console | |||
|
|
|||
| $ /Android/cmdline-tools/latest/bin> | |||
| $ /Android/cmdline-tools/latest/bin>sdkmanager.bat --list | |||
| $ \Android\cmdline-tools\latest\bin | |||
There was a problem hiding this comment.
incorrect on mac/unix slashes go other way and it's under the mac section.
Like this part of the documentation: https://docs.odk-x.org/docs-tech-guide/#before-you-begin
notice the "bash" and "PowerShell" tabs to explain the difference
designer-prereqs.rst
|
Hey @wbrunette I have made certain changes. I just wanted to say that in the note that is in line 166, it is mentioned that for windows the command should be sdkmanager.bat, so in line number 182, I have kept the slashes for the windows set up as it has the command sdkmanager.bat mentioned in it. In line 181, assuming it to be for Mac, I have changed the slash style. Please review it and provide me with your feedback. PS -: In my opinion, separating the commands for windows and for Mac/Unix would probably be better for understanding for future contributors. |
|
My comment applies to all changes, and I agree about your PS hence I gave you a link to another documentation page that does it properly. Check out the link I supplied and look at the tabs |
original documentation.
|
@wbrunette , I have changed the slashes to as they were in the original documentation |
|
What about Line 192 and Line 199 |
they were in the original documentation.
|
Changed line 192 and 199 to what they were originally |
This PR is not related to any issue. It is towards making the documentation of ODK-X better.
What is included in this PR?
Made certain changes for better readability and understanding of the text for contributors, one of the main things was to change the directory structure given in the setup for Android Studios for Windows in the app-designs-prereqs.rst file for better understanding of others