search

cite-architecture / CITE-App

An end-user environment for working with data in the CITE environment—browsing and analyzing texts, viewing objects and images, visualizing graphs of scholarly data. Written in ScalaJS.
GNU General Public License v3.0
15 stars 3 forks source link

Some kind of online help #46

Open Eumaeus opened 7 years ago

Eumaeus commented 7 years ago

My inclination is to do "help" in the app's GitHub Wiki, and just include a link to that on the app's page. That way, you, I, our students, Neven, or anyone can build out help as needed.

Is this a good idea, or a terrible idea?

neelsmith commented 7 years ago

Maybe slightly better variant: let's get up a ghpages web site with some help we author, links to APIs, and link to a wiki anyone can contribute to. Both what you suggest AND our own stuff if we choose to.

neelsmith commented 7 years ago

(But definitely keep help functions outside the app!)

Eumaeus commented 7 years ago

I've started a basic wiki. I despise working with ghpages and that damned Jekyll. But of course it is best. I'll build out some help in the Wiki, for now, and we can move it to ghpages at some point in the future.

neelsmith commented 7 years ago

We don't need to do ghpages if you hate it. It's just a reliable, free web host you can throw markdown at, so I've used it for that reason.

Still, I'm glad to throw some stuff together on ghpages if you think we should

Sent from my iPad

On Apr 13, 2017, at 6:41 PM, Eumaeus notifications@github.com wrote:

I've started a basic wiki. I despise working with ghpages and that damned Jekyll. But of course it is best. I'll build out some help in the Wiki, for now, and we can move it to ghpages at some point in the future.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or mute the thread.

Eumaeus commented 7 years ago

No, let's use ghpages. They look good and are easy to find and professional-seeming. Once it is all set up It is easy enough to add stuff. I