First attempt at DELPH-IN docs website #108
EricZinda
started this conversation in
Team Posts
Replies: 1 comment
-
I've ditched Google search for the moment. I just couldn't get the level of control from it that I think we need. I'm now using a simple client based approach called "lunr". Turns out it works surprisingly well (at least I think so)! When you use search on the new site, you are doing a full text search through the whole wiki. Try it out by clicking on the magnifying glass in the upper right corner of the new site and tell me what you think! |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
OK, here’s my best cut at building the docs website out of all the current content in the Delph-in wiki: https://blog.inductorsoftware.com/docsproto/home/Home/. The goal is to use our new documentation "technology" to get an early win by simply making what we already have easier to find and navigate.
My apologies up front for anything I misclassified, underrepresented, etc. @danflick is going to do a review pass with a small group in a room to try to get a deep review done quickly. However, any feedback is welcome now as well!
I started with root pages like the DELPH-IN intro, welcome pages, erg semantics pages, etc, and then just followed all the links until there were no more to follow. It includes the transitive closure of all links in the pages inside of it (at least the ones that existed, there were plenty that were broken).
It has new pages that outline how the site is built and how to update it in the “Garage” section at the bottom: https://blog.inductorsoftware.com/docsproto/garage/DocsQuickStart/.
For searching the site, I'm trying Google search because it is free and presumably they do a good job at searching. We can get rid of the ads by filling out some forms to prove this is an "academic" site. If we go this direction we can go through that. Let me know if you think it is good enough.
There are "edit" links with the last modification on every page to make it easy to edit the docs in their original location. You need run the workflow to create a new docs site to get any updates you make, though.
The system allows for doing much more than I did: we can include pages from other wikis or sites from Github, we can generate docs from things like grammars, etc.
Again, any and all feedback welcome! And did I mention all the technology used and hosting here is free?
Beta Was this translation helpful? Give feedback.
All reactions