Address shortcomings in release documentation #181
Labels
cleanup 🧹
Related to cleaning up code, whether its format, organization, variable names, etc.
documentation
Improvements or additions to documentation
x small
less than 1 day
Release documentation:
1. Ambiguous working directory
In section "Create and Distribute a new Android build", step 3 shows a shell command (
cp ...
). When I got to that step, I was still in Android Studio, and so I opened up a terminal window in there. That placed me at some subdirectory instead of at the root directory of the repo. The author of this step intended for the reader to run the command from the root directory of the repo.Suggestion: Either update the step to indicate the working directory, or update the instructions to guide the reader to return to their original terminal window (not within Android studio), or both.
2. Spelling error
In section "Create and Distribute a new Android build", step
2.iii
:3. Sacrificing changelog and diff
This one may involve more than just updating documentation; and so may work better as a standalone GitHub Issue.
We noticed that, when we add a build to an existing GitHub Release (instead of creating a new Release), we don't get a changelog or a diff specific to the new build's changes. Maybe we could change our process so that each build also gets its own GitHub Release. If we are going to sunset the PWA, there may be fewer implications to us making such a change to our process.
The text was updated successfully, but these errors were encountered: