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

Improvements to app docs #185

Merged
merged 4 commits into from
Aug 5, 2020
Merged

Improvements to app docs #185

merged 4 commits into from
Aug 5, 2020

Conversation

esreli
Copy link
Contributor

@esreli esreli commented Jul 22, 2020

This PR:

  • introduces a TOC to (2) README files. The TOC was generated using MDTOC.
  • increments app version patch number
  • describes doc changes in RELEASE
  • renames docs/index.md to docs/README.md

@puneet-pdx i'm additionally requesting your review to ensure i've properly updated the app version number in the project.

Copy link
Contributor

@mikewilburn mikewilburn left a comment

Choose a reason for hiding this comment

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

Only one change that I caught for readability. Otherwise, this looks good.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Mike Wilburn <[email protected]>
@esreli esreli requested a review from mikewilburn July 30, 2020 18:08
Copy link
Contributor

@mikewilburn mikewilburn left a comment

Choose a reason for hiding this comment

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

Latest change looks good, but I've just found something else which caught my eye!

Comment on lines 12 to 13
versionCode = 1
versionName = '1.0.8'
Copy link
Contributor

Choose a reason for hiding this comment

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

According to Android's documentation, I don't think we need the = signs here:

Suggested change
versionCode = 1
versionName = '1.0.8'
versionCode 1
versionName '1.0.8'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'd like to keep as-is. This file was auto-generated by Android Studio.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Are you on the latest version of Android Studio ? if not it might be the reason why auto-generation did it that way.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Or may be older gradle plugin.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When prompted to update, i'm provided this information:

To take advantage of the latest features, improvements, and security fixes, we strongly recommend that you update the Android Gradle plugin from the current version 3.3.2 to version 3.6.3 and Gradle to version 5.6.4.

Updating now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated Android Studio and gradle, there was no error thrown with keeping = as-is. With that said, the Android documentation suggests a format without the =. So, i've updated the gradle file accordingly.

c1b567b

@esreli esreli requested a review from mikewilburn July 30, 2020 20:07
@esreli
Copy link
Contributor Author

esreli commented Jul 31, 2020

@puneet-pdx are we good to go here?

Copy link
Collaborator

@puneet-pdx puneet-pdx left a comment

Choose a reason for hiding this comment

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

LGTM

@esreli esreli merged commit 01730e3 into master Aug 5, 2020
@esreli esreli deleted the patch-1.0.8 branch August 5, 2020 16:13
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.

None yet

3 participants