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

Deduplicate and improve development docs #214

Closed
mrsarm opened this issue Sep 30, 2021 · 1 comment
Closed

Deduplicate and improve development docs #214

mrsarm opened this issue Sep 30, 2021 · 1 comment
Assignees
Labels
Type: Technical issue Improve something that users won't notice
Milestone

Comments

@mrsarm
Copy link
Contributor

mrsarm commented Sep 30, 2021

We have documented the branding and signing process here in the official docs and here in the README. Moreover, the text are not exactly the same.

We should:

  • Merge/move all the development guides from the README to the community docs
  • Only leaves links in the README of where in the community docs find how compiling and branding the app.
  • Improve the section with the development tools required. E.g.:
    • This post a user was confused about base16.
    • The section mention as requirement the keytool that is already part of any Java distribution mentioned in the first item (BTW the Java 11 should also be replaced by Java 11+ because the SDK takes care of lowering the targeted Java version when compiling).
    • The make command is also required
  • Fix target name keyprint-aabkeyprint-bundle in https://docs.communityhealthtoolkit.org/apps/tutorials/android-wrapper/#2-building-the-apk-and-aab-files.
@mrsarm mrsarm self-assigned this Sep 30, 2021
@mrsarm mrsarm added this to the 0.11.0 milestone Oct 5, 2021
@mrsarm mrsarm added the Type: Technical issue Improve something that users won't notice label Oct 19, 2021
@mrsarm
Copy link
Contributor Author

mrsarm commented Nov 15, 2021

Implemented in both PRs mentioned above.

@mrsarm mrsarm closed this as completed Nov 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Technical issue Improve something that users won't notice
Projects
None yet
Development

No branches or pull requests

1 participant