search

csi4999-mims / documentation

Supporting materials for the MIMS system
Other
0 stars 0 forks source link

Merge the documentation into a single file #133

Closed ghost closed 6 years ago

ghost commented 6 years ago

Question/suggestion

What are your feelings (if any) on merging our documentation into a single file rather than having them as separate files?

Justification

With all the documentation in a single file, we can

1) Automatically generate and update a Table of Contents 2) Export the document as a PDF for easy sharing and submission 3) More easily spot inconsistencies in the documentation and correct them

I have pulled everything into one README for demonstration purposes.

ghost commented 6 years ago

The only thing that the merged version is missing is are titles for the major sections (which we have denoted through naming conventions). What name would you ascribe to the headings with a checkbox?

ghost commented 6 years ago

I've started a branch for this. It's called issue-133-readme-merge.

(GitHub does not support referencing a branch through anything but strict URL's.)

ghost commented 6 years ago

I'll make the section titling another issue. This one's original scope has been accomplished.