Skip to content
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

Build User Guide for v1.4 from Docs folder #49

Open
justingeeslin opened this issue Jul 30, 2020 · 3 comments
Open

Build User Guide for v1.4 from Docs folder #49

justingeeslin opened this issue Jul 30, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@justingeeslin
Copy link
Member

justingeeslin commented Jul 30, 2020

With the new 1.4 release, we should think about a User Guide for this release, and every subsequent release.

The vision:

  • Built from community-maintained markdown files
  • Includes bookmarks, like the original. Great idea for a PDF so large
@justingeeslin
Copy link
Member Author

My initial plan of attack is to move the current User Guide into the docs Jekyll site, then use something like wkhtmltopdf to transform that into a PDF.

@justingeeslin
Copy link
Member Author

Practicing the PDF to Markdown conversion with #51; will move the tutorial before the entire User Guide.

@justingeeslin
Copy link
Member Author

I've created an Markdown version of the User Guide. Thank goodness for pandoc. This is currently kept in the feature branch feature/user-guide-html.

There's still a lot of work to do before this is ready to convert into a new PDF, but that's the goal.

@justingeeslin justingeeslin self-assigned this Jul 31, 2020
@justingeeslin justingeeslin added the documentation Improvements or additions to documentation label Jul 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant