-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Switching documentation to use the jupyter-book structure #544
Conversation
Apologies for the delay, got caught up in other things for a bit here. The long and short of it is that this PR:
It's entirely likely that further revisions to the manual will be needed for formatting, it was quite a long document and the translation of the formatting from Word to Markdown was not as automatic as Pandoc made me think it might be, so I very well could have missed something when going through it manually. @g4brielvs it's a lot of changes, for a review I'd suggest you checkout the branch and build the documentation locally and have a quick look. @gronert-m was very open to an iterative approach to improving this documentation, so once you sign off on this we can get it merged and built, which will make the new documentation easy for him to view and provide additional feedback on. Thanks all. |
@elbeejay Thanks! In regard to build/workflow, it works and it closes #541. I'll defer to @gronert-m to review/provide feedback on the content. A preview is available at this link (a different link just to preserve the current documentation). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In regard to build/workflow, it works!
@gronert-m - we are pending your approval and merge for this documentation to go live. |
@gronert-m what's the plan here? The branch is only going to get more stale and there are only going to be additional conflicts as files change. Is there anything you'd like changed or revised here before this is merged? |
Overhauling the documentation to use the
jupyter-book
format based on the template.Converted the
gld/Support/A - Guides and Documentation/GLD_Manual_V.1.0.docx
file into an.md
file with pandoc but still need to manually go in and clean up the formatting..md
file) - will likely need another few passes to catch everything... it's a long fileSimilarly, an initial take on dynamic generation of a page with the harmonization script hierarchy and links to each
.do
file has been started, but I need to get the GitHub workflow fixed and check the formatting of the output.md
file more closely.There are a bunch of stubs and placeholders in the documentation, and some redundancies (multiple locations and files for contributing for example) that I'll attempt to trim down and set some basic information in as well.
Will mark this as "Ready" once complete, but wanted to keep you both in the loop @g4brielvs and @gronert-m