bluefin-help
https://discord.com/channels/1072614816579063828/1087140903031943178/1214633597227634688
@bketelsen i am playing around with this for bazzite documentation right now, thanks for making this!
43 Replies
So is this an app that runs on the desktop?
well... if you include GNOME's yelp application
then yes
it's essentially GNOME Help but you can change the text with mallard markup language
i am running into a percuilar bug where each time i launch it, the window height increases on KDE plasma
almost comically
hey @bketelsen
could we make an action that slurps every post on the forum tagged with
documentation, converts it from markdown to a format mallard expects, and then we copy it onto disk in the image.
and then the same for the KDE help thing
then we're done@Noel it's
yelp which is already included on the desktop, my demo repo just includes tools to create & compile the help docs
the output can be many formats, but epub is the most compact and easy to drop on to one of our images
we can do anything we set our minds tokyle found a html2mallard python package, but it's not liking it so far 😄
i honestly wouldn't mind doing it by hand manually, even if it might take me a couple of weeks. jorge suggested it would be easier to do all of that above by scraping the discourse documentation. far easier and automated which is what we like, but im not sure how much easier it would be. it seems to be very particular, but i think i need to understand and learn what im doing better
so far i have this mess lol but im honestly shocked i got this far
^this is all manually
if i try the markdown from the discourse conversion the page refuses to load
should mention that it's only included on GNOME images
ofc you made this for bluefin originally 😅
KDE has their own fun Qt Help application
KDE's KHelpCenter uses DocBook while GNOME's Yelp uses Mallard
writing all of this down here so all of that information is here if we need it for anything
anyways this is a great project bketelsen
@nickname
Edit: my bad, not a default, I made a mistake in reading
For your information, this will be the default help app for Gnome 46:
https://flathub.org/apps/app.drey.Biblioteca
Fedora usually delays Gnome default apps choice or in some cases, don't implement them at all (Terminal vs BlackBox situation)
:build_failed:
https://pypi.org/project/html2mallard/ <-- this is a great tool
you can take the markdown documentation from the docs on discourse, paste them into a file and make sure it's a
.md file. convert it to mallard and then fix any issues it has by hand
it's not perfect by any means, but it's faster this way
sweet! its also works offline, doesnt it?
this is so cool
yea
i still need to do a lot but it's nice
super sweet
but like
You are kicking ass my friend. Love all the work you have been putting into the documentation and new user experience.
are you copying each page and converting it?
I was wondering the same thing.
seems to be really annoying if thats the case
probably could write a scraper for that
im using html2mallard to convert the markdown files to mallard, but i have to edit them anyways since it's not perfect by any means lol
what do you need to edit?
is it just styling or info in general?
both
okok
most of the work has already been done by bketelsen's bluefin-tools lol
i am only forking it and adding documentation relevant to bazzite
i can help with the bluefin docs too. im almost done with the bazzite docs (hopefully) but like i can use html2mallard, fix up any errors that have made and format it properly for the bluefin documentation too
This looks really awesome!!!
@nickname what do we need to pull this in? Working on ISO things tonight so might as well get this in there
yelp and possibly yelp-tools idk how to connect it all though. i didnt exactly fix up the docs yet like i said, i will tonight when im on my desktop. been waiting for a phone call all day so far
it works if you cd into the directory of the docsoh ok so maybe we just have to copy some files into the right directories?
when i actually do them
the reference files I PR'd yesterday most likely wont function
understood!
they can be edited directly pretty easily
it's all formatting stuff
https://github.com/nicknamenamenick/bazzite-help/tree/bluefin-help
if anyone wants to see this for themselves, here it is
GitHub
GitHub - nicknamenamenick/bazzite-help at bluefin-help
(WIP) Bazzite documentation for GNOME images. Contribute to nicknamenamenick/bazzite-help development by creating an account on GitHub.
i didnt edit any of the bluefin docs, so they are not formatted correctly (yet)
but you can see how this works and how i plan to have it 'formatted' on the main index page
wow!
Awesome!! On the road but loving how it looks!
So no rush to do this, but eventually, would a KHelpCenter? Instead of Mallard, it uses DocBook for their XML. I see this is utilizing
yelp-tools but I'm not sure if the same thing can be made with KDE's help application.
This is an amazing tool bketelsen!
i will be returning to this endeavor sooni shall return soon
i might try to do this with bazzite first since i kind of know what docs i want to include
note for myself:
https://universal-blue.discourse.group/docs?topic=561
plan is to have bazzite offline docs mimic this setup^ but some removed pages (README, installation guide, etc.) and some portions removed in the FAQ that apply to explaining what Bazzite is to a new user who hasn't installed it yet.
Universal Blue
Bazzite Documentation
General 📜 Bazzite’s README ❓ FAQ 📖 Installation Guide 🎲 Gaming Guide 🤝 Contributing to Bazzite Steam Gaming Mode (Handheld/HTPC Images) 📺 Steam Gaming Mode Overview 📑 Handheld Wiki ⌨ Change Physical Keyboard Layout for Gaming Mode Software ⬇ Installing and Managing Applications 📱 Waydroid Setup Guide 📹 Davi...