Since a few days back I have discovered an application called EndeavourOs apps info in my system. I’m pretty (?) sure that I had never seen it before. Is it a new addition to eos-shared-bash? Otherwise I cannot explain how I could have missed it all along.
Is this leading to a need for Wiki entries for each - so that it can be called up this way? Or - some alternate form of man-like pages that can be called up?
To be honest, I don’t know yet.
There are pros and cons in all alternatives.
It would be nice to have a uniform set of info pages, but it takes quite much time to achieve that.
So if anyone can help with the design and implementation, that would be very much appreciated.
My first thought is to implement wiki entries for most of them, by entering/expanding(?) the Git readme.md where possible. My second thought is to create an eos-man (?) which displays the readme.md files more directly, without needing a browser. Either way, some judicious editing is probably the way to go - perhaps a mini-tutorial on usage?
Obviously you haven’t the time for that - you’re creating/maintaining them! I guess I should go digging and see what I can come up with for a few of them for you to see what it would look like…
I’ll get a start on that pretty quick - it sounds (strange, I know) fun in a quirky way.
The information about EndeavourOS packages is in many different places now.
For offline info pages, if a decent md viewer is available, then we could use that.
We already have quite many md documentation files. In addition we have wiki pages. These two formats are the largest amount of information. Other formats are a minority currently, so they could be converted to a better format, either md or wiki (which are not far apart from each other). Note that we have man pages and command help pages as well…
But feel free to examine this and let me know what you think! Maybe you come up with the best solution!
If this is to be the information center for EnOS tools then I would like to propose using MD or man pages for offline use. Because if we go with the WiKi then users need to have an active internet connection. Keeping these smaller information files offline would be good in case of no internet access.
I’m not a big-time programmer but I have taught myself some C# (I should have gone with C++ or C), PHP, JavaScript, and a few other web tech stuff (mainly backend not a front end person). But work as an IT admin (servers and network stuff). I can help with WiKi pages or any other documentation if needed. You guys have seen my blog (minus the spelling issues ).
I tend to agree with your thoughts on that, with the exception that I think the information should be on the wiki as well. Whether the default is to go with the offline version, or perhaps check if online and then decide - that is for later. Things are better presented online for clarity, however - because trying to make the offline look good might well require some additional packages. Even something simple like mdless (md version of less, with additional navigation) pulls in a bunch of ruby stuff to function… and something like lynx I haven’t even tried yet! Maybe I’ll have to dust off my ‘C’ skills to make something better. Anyone got a powerful leaf blower handy?
Actual ‘C’? Yup - C++ and C# etc didn’t exist back then… I used ‘C’ where it didn’t seem worth it to write in 680x0 assembly! I miss the Amiga…
This was my first thought but didn’t say it because it’s still in its baby stage. A better mechanism should be to check if an active connection is there if there is set the wiki as info DB if not set offline pages. But to get this off the ground we should try to keep it simple. I do agree with you.
I started with TC and TP (Turbo Pascal). Then I lost touch because my profession targeted the networking side. But I still try my best to learn to program because I love to stare at walls and to pull my hair out searching for a missing semi-colon.
Hmmm - Turbo Pascal… I remember that, although I tended to use Modula-2 more - then Delphi - but I tried a lot of things!
Anyway - What is needed is a consistent look for markdown, then I can import/transfer them to the Wiki easily enough. Offline, the mdless works OK, but I wish I had fewer dependencies involved. More research needed - but Markdown is still a good thing to have done. Here’s a pic of some sample .md file in mdless for reference:
Usable, but not thrilling! Another possibility is converting .md to .html and feeding it to lynx - but let’s get them all in 1 place/style first!