Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Online documentation #62
This PR adds online documentation for Hydra using GitHub Pages.
You can see more or less what they look like here: https://ssssam.github.io/hydra/, it's identical to this PR (apart from the bits that say "Sam Thursfield fork" of course :)
If you merge this branch to master and configure the repo to serve Pages from the 'master' branch
I'm happy to revise the PR a bit based on feedback, although bear in mind i'm not much of a web designer.
In this branch I did some minimal editing of the existing docs (basically to deduplicate them into a single file), and added a simple Jekyll configuration using the minimal-mistakes theme. I chose that theme because it supports a sidebar navigation menu, I didn't find any others which support that.
We should avoid having duplicate content in the repository. The individual documentation sections will be combined in a static Jekyll website from now on, so they should still be easy to read.
The site can be viewed locally, if you `gem install jekyll` and then run `jekyll serve docs/`. (You'll need to edit the first key in docs/_config.yml for the theme to work locally). And it can be uploaded into GitHub Pages. The repository will need to be configured to build GitHub Pages content from the `docs/` subdirectory of the 'master' branch.
Hey this is really cool! I would like to include this documentation in the existing site at https://hydra-editor.glitch.me, rather than create a separate website. I think it could be another button in the top menu that pulls up the documentation. What do you think / would you be interested in working with me to integrate the two?
I chose GitHub Pages because it seemed easiest, but I can see it makes to integrate it into the existing editor instead. Let's at least scope it out and see how hard it would be :)
I guess we find a tool that can run as an
And how would we integrate the docs with the display ... in the existing popup dialog? That's simple but it means you can't edit the code while reading the docs.
Yes good idea to scope it out!
I am going to put all of the things I am thinking here, doesn't mean that an initial implementation has to include all of these things, but rather a roadmap to work towards.
This branch by @alvarobyrne is a good starting point for all of these things: https://github.com/toplapbogota/hydra/tree/documentation?fbclid=IwAR38BIrUAXtEIF5t4r6lqp27yEMMSYrfpTh2jhueCbKNUbYJ1blHx7p1zKA It is missing a more general documentation, as well as integration with the popup window, but has basically everything else. I haven't had time to work on this aspect in a while so unfortunately haven't been able to integrate yet :)
Thanks for the info! And for the link to Alvaro's branch which is very useful to get an idea for how things should work.
Making the help popup draggable and dockable would be great. I think we should use a 3rd party library for that if possible - I found a few that support draggable dialogs, but none that support dockable ones. My current favourite based on 10 mins googling is jBox.
Here's a proposed list of work items which I think will bring us close to your design. Let me know what you think!
After these we'd have a good proof of concept, and we could think about