search

JamesMc86 / G-CLI

A proxy mechanism allow LabVIEW programs to easily write out to the command line.
BSD 2-Clause "Simplified" License
71 stars 19 forks source link

Improve Documentation #127

Open JamesMc86 opened 1 year ago

JamesMc86 commented 1 year ago

The existing documentation needs work.

We have documentation in the wiki on github but it isn't very intuitive to navigate.

Should look at generating a static site or organise the wiki in a more useful way.

JamesMc86 commented 1 year ago

Maybe just my personal familiarity but like the idea of mdbook (https://rust-lang.github.io/mdBook/) although an ASCIIDoc version might allow us to use Antidoc for VI documentation

OlivierJourdan commented 1 year ago

Hi James, May I encourage you to look at Antora to create a doc site? I've been using it for Wovalab's os projects --> https://wovalab.gitlab.io/open-source/docs/ It's made for project documentation (support for multiple version) and use Asciidoc syntax, which makes Antidoc output integration straightforward.

I'd be happy to help.

JamesMc86 commented 9 months ago

Be sure to include this: https://github.com/JamesMc86/G-CLI/issues/147#issuecomment-1656767586

JamesMc86 commented 8 months ago

I've gone for MdBook in the end just for a simpler experience getting going and the wiki is all converted at HTTP://jamesmc86.github.io/G-CLI

I think it is easier to read with a bit more structure than the wiki offered.

Final touches: