Edits to Documentation

[jonlym]

Overall edits

• Updated README.md to break apart paragraph into sections.
• Added internal links to run.md.
• Converted files to use less than 80 characters per line.
• Fixed miscellaneous typos.
• Changed 'entropy of formation' to 'standard entropy'.
• Changed headers in theory.md to standard black color. (Were these blue on purpose?)

Open questions

• Is ck_conversion.md accessible on the documentation page? I didn't see a link to it.
• Can we edit the stylesheet to have a larger font for 3rd and 4th headers? The headers are a smaller font size than the text.
• We should add a link back to the GitHub repository. Makes it a lot easier to navigate.
• Would it be possible to add images or samples of the output files to output.md? The files are rather text heavy and it would be good to break it up.

[mbkumar]

Hello Jon, Thanks for the changes. Regarding your questions, see my responses below.

• I was experimenting with color when making changes to theory.md mainly because it is text heavy. I used color to add some visual breaks.

• I was using ck_conversion.md in an earlier iteration of documentation. Not using it now, but kept it.

• I have noticed the issue with 3rd and 4th header, but not sure how to resolve it. One thing I would probably do is use 2nd header in place of 3th and 4th headers and use color to establish hierarchy.

• Will do once we are close to the release.

• output.md is text heavy, but description for each file is demarcated . Also I kept the description for each file short on pupose.

[jonlym]

I see, thanks for the response!

Maybe we can edit the main.css file to get H3 and H4 to be larger?

Similarly, if we use blue (or whichever format) for one heading then I think we should keep it consistent across all the documents.

[mbkumar]

The css file is being used only to specify the layout of the website. Content formatting is all done through jekyll and github markdown syntax. I'll make the colors consistent.

On Tue, Jun 11, 2019 at 9:50 AM Jonathan Lym notifications@github.com wrote:

I see, thanks for the response!

Maybe we can edit the main.css https://github.com/VlachosGroup/openmkm/blob/master/docs/css/main.css file to get H3 and H4 to be larger?

Similarly, if we use blue (or whichever format) for one heading then I think we should keep it consistent across all the documents.

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/VlachosGroup/openmkm/pull/7?email_source=notifications&email_token=AA62VEHPPLPA3XZ5ANP3RKLPZ6UR3A5CNFSM4HWWTNEKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODXNF5BI#issuecomment-500850309, or mute the thread https://github.com/notifications/unsubscribe-auth/AA62VEFISCHD7Y6BL52NDDLPZ6UR3ANCNFSM4HWWTNEA .

--

Bharat Medasani Postdoctoral Associate, Pacific Northwest National Lab Richland, WA 99354 USA