70 replies

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!

tryhardsoccermomswagOP•3/7/24, 4:16 AM

Noel•3/7/24, 4:17 AM

So is this an app that runs on the desktop?

NNoel So is this an app that runs on the desktop?

tryhardsoccermomswagOP•3/7/24, 4:19 AM

well... if you include GNOME's yelp application

tryhardsoccermomswagOP•3/7/24, 4:19 AM

then yes

tryhardsoccermomswagOP•3/7/24, 4:20 AM

it's essentially GNOME Help but you can change the text with mallard markup language

tryhardsoccermomswagOP•3/7/24, 4:20 AM

i am running into a percuilar bug where each time i launch it, the window height increases on KDE plasma

tryhardsoccermomswagOP•3/7/24, 4:20 AM

almost comically

j0rge•3/7/24, 4:34 AM

hey @bketelsen

j0rge•3/7/24, 4:35 AM

could we make an action that slurps every post on the forum tagged with documentationdocumentation, converts it from markdown to a format mallard expects, and then we copy it onto disk in the image.

j0rge•3/7/24, 4:41 AM

and then the same for the KDE help thing

j0rge•3/7/24, 4:41 AM

then we're done

bketelsen•3/7/24, 6:52 AM

@Noel it's yelpyelp which is already included on the desktop, my demo repo just includes tools to create & compile the help docs

bketelsen•3/7/24, 6:53 AM

the output can be many formats, but epubepub is the most compact and easy to drop on to one of our images

Jj0rge could we make an action that slurps every post on the forum tagged with `documen...

bketelsen•3/7/24, 6:53 AM

we can do anything we set our minds to

tryhardsoccermomswagOP•3/7/24, 7:01 AM

kyle found a html2mallard python package, but it's not liking it so far

tryhardsoccermomswagOP•3/7/24, 7:02 AM

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

tryhardsoccermomswagOP•3/7/24, 7:03 AM

so far i have this mess lol but im honestly shocked i got this far

tryhardsoccermomswagOP•3/7/24, 7:04 AM

^this is all manually
if i try the markdown from the discourse conversion the page refuses to load

Bbketelsen @Noel it's `yelp` which is already included on the desktop, my demo repo just in...

tryhardsoccermomswagOP•3/7/24, 7:05 AM

should mention that it's only included on GNOME images

tryhardsoccermomswagOP•3/7/24, 7:05 AM

ofc you made this for bluefin originally

tryhardsoccermomswagOP•3/7/24, 7:06 AM

KDE has their own fun Qt Help application

tryhardsoccermomswagOP•3/7/24, 7:09 AM

KDE's KHelpCenter uses DocBook while GNOME's Yelp uses Mallard

tryhardsoccermomswagOP•3/7/24, 7:09 AM

writing all of this down here so all of that information is here if we need it for anything

tryhardsoccermomswagOP•3/7/24, 7:12 AM

anyways this is a great project bketelsen

fiftydinar•3/7/24, 12:23 PM

@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)

Flathub - Apps for Linux

Install Biblioteca on Linux | Flathub

Documentation viewer for GNOME

tryhardsoccermomswagOP•3/8/24, 5:17 AM

:build_failed:

tryhardsoccermomswagOP•3/8/24, 5:17 AM

https://pypi.org/project/html2mallard/ <-- this is a great tool

PyPI

html2mallard

convert mkdocs´ html output to mallard/yelp xml

tryhardsoccermomswagOP•3/8/24, 5:18 AM

you can take the markdown documentation from the docs on discourse, paste them into a file and make sure it's a .md.md file. convert it to mallard and then fix any issues it has by hand

tryhardsoccermomswagOP•3/8/24, 5:18 AM

it's not perfect by any means, but it's faster this way

tryhardsoccermomswagOP•3/10/24, 5:49 PM

https://github.com/nicknamenamenick/bazzite-help

Ttryhardsoccermomswag https://github.com/nicknamenamenick/bazzite-help

tulip•3/10/24, 7:46 PM

sweet! its also works offline, doesnt it?

tulip•3/10/24, 7:46 PM

this is so cool

Ttulip sweet! its also works offline, doesnt it?

tryhardsoccermomswagOP•3/10/24, 7:48 PM

yea

tryhardsoccermomswagOP•3/10/24, 7:48 PM

i still need to do a lot but it's nice

tulip•3/10/24, 7:48 PM

super sweet

tulip•3/10/24, 7:48 PM

but like

Ttryhardsoccermomswag i still need to do a lot but it's nice

Noel•3/10/24, 7:48 PM

You are kicking ass my friend. Love all the work you have been putting into the documentation and new user experience.

Ttryhardsoccermomswag https://pypi.org/project/html2mallard/ <-- this is a great tool

tulip•3/10/24, 7:49 PM

are you copying each page and converting it?

Ttulip are you copying each page and converting it?

Noel•3/10/24, 7:49 PM

I was wondering the same thing.

tulip•3/10/24, 7:49 PM

seems to be really annoying if thats the case

tulip•3/10/24, 7:49 PM

probably could write a scraper for that

Ttulip are you copying each page and converting it?

tryhardsoccermomswagOP•3/10/24, 7:50 PM

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

tulip•3/10/24, 7:51 PM

what do you need to edit?

tulip•3/10/24, 7:51 PM

is it just styling or info in general?

tryhardsoccermomswagOP•3/10/24, 7:51 PM

both

tulip•3/10/24, 7:51 PM

okok

tryhardsoccermomswagOP•3/10/24, 7:54 PM

most of the work has already been done by bketelsen's bluefin-tools lol

tryhardsoccermomswagOP•3/10/24, 7:54 PM

i am only forking it and adding documentation relevant to bazzite

tryhardsoccermomswagOP•3/11/24, 2:21 PM

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

j0rge•3/12/24, 12:54 AM

This looks really awesome!!!

bluefin-help

Similar Threads

Similar Threads

Similar Threads