Improvements to app documentation

Esri / dynamic-situational-awareness-qt

Dynamic Situational Awareness Qt

Apache License 2.0

53 stars 22 forks source link

Improvements to app documentation #345

Closed mikewilburn closed 4 years ago

mikewilburn commented 4 years ago

This PR:

renames docs/index.md to docs/README.md
adds table of contents to (2) README files. The TOC was generated using MDTOC.
links to docs/README.md from the root README.md
makes a number of formatting corrections to root README.md (924719d & ef1ac8b)
describes patch changes in RELEASE.md
increments app version to the applicable patch number

@anmacdonald I might need your help with incrementing the app version in various locations. I'm not positive I caught them all in be155c3.

mikewilburn commented 4 years ago

@esreli the TOC in the detailed doc was a bit tricky. Since the doc it makes use of multiple h1s, it seemed useful to leave the generation defaulted to firsth1:1. I then placed the TOC at the immediate top of the document titled by "Contents". See what you think.

anmacdonald commented 4 years ago

@mikewilburn you've discovered all the files that needed updated! The only missing piece of the puzzle is that android:versionCode needs updated with andoid:versionName. Both are documented here. It's an annoying gotcha, I've pushed the change up to your branch.

FYI, v.next is currently at v1.2.0, if you want you could branch off of that and then merge back into v.next as well. Your changes could become part of the upcoming 1.2.0 release and you wouldn't have to worry about a 1.1.3.

mikewilburn commented 4 years ago

Thanks for pushing up the Android version number changes @anmacdonald!

Regarding the broken TOC links, in my latest commit, I've taken @esreli's suggestion of removing the icon images from the heading lines and incorporating them immediately below into the content's body. This allows us rely on automatic generation of the TOC rather than having to manually override it each time. See what you think.

mikewilburn commented 4 years ago

FYI, v.next is currently at v1.2.0, if you want you could branch off of that and then merge back into v.next as well. Your changes could become part of the upcoming 1.2.0 release and you wouldn't have to worry about a 1.1.3.

@anmacdonald if it's no different to you, I can simply rebase v.next with these changes after this PR's been merged. That might be a tad easier at this point.