minetest / contentdb

A content database for Minetest mods, games, and more
https://content.minetest.net
GNU Affero General Public License v3.0
93 stars 45 forks source link

Automatically synchronize the mod description at forums and other websites #346

Closed HybridDog closed 2 years ago

HybridDog commented 2 years ago

Problem

In my opinion it is difficult/tedious to synchronize Mod descriptions in the Github Readme, the forum pages and contentdb. For example, when the dependencies of my mod change, I'd need to update this information at three webpages. Currently I try to avoid duplicate descriptions and show a link to the forum instead, but separating the description from the code is bad because the forums are not guaranteed to always be online.

Solutions

It could be possible to automatically generate SVG files for the Markdown descriptions of the mod at content.minetest.net. The SVG can be shown as image on Github and the forum pages, and would always be up to date. For example, the image at URL https://content.minetest.net/packages/TenPlus1/mobs/description.svg could show the current description of the mobs mod.

Alternatives

Showing the SVG description instead of an additional written one would be a completely optional feature.

Additional context

Here's an example SVG for the Mesecons mod description. The links don't work because I manually converted it to SVG with Inkscape after downloading as PDF with Firefox, but the text can be selected if the SVG is opened in an own browser tab. bla