search

Esri / data-collection-ios

Mobile data collection app using the iOS Runtime SDK.
https://developers.arcgis.com/
Apache License 2.0
25 stars 26 forks source link

Add TOCs and rename detailed documentation #245

Closed mikewilburn closed 4 years ago

mikewilburn commented 4 years ago

This PR uses the atom-mdtoc package for Atom to introduce tables of contents at the top of our two documentation markdowns - the root README.md as well as the one located at docs/index.md.

It also ensures the detailed documentation is directly referenced from within the README at the repository's root.

Lastly, it renames docs/index.md to docs/README.md to leverage automatic rendering within that directory.

mikewilburn commented 4 years ago

Fyi, looks like my commits inadvertently removed a number of trailing spaces within the affected documents, so be aware that it may appear as though more lines have changed than in actuality.

mikewilburn commented 4 years ago

@esreli I think I took care of all of your suggestions. Have another look and see what you think? Let me know if you think where I added mention of the MDTOC extension in the root README makes sense.

Comment: MDTOC [...]

I take it this comment is used by the atom extension for generating a TOC with the same parameters from person to person? Is it such that the TOC is generated just under the comment?

Yes, this is exactly correct. Changing any of the in-line markdown comments for the MDTOC parameters will affect the way the table of contents generates from that point onward.