xbps-src-tutorials / xbps-src-tutorials.github.io

xbps-src tutorials
https://xbps-src-tutorials.github.io/
BSD 2-Clause "Simplified" License
7 stars 2 forks source link

Use proper version string in tutorial templates #4

Closed HiPhish closed 4 months ago

HiPhish commented 4 months ago

I am not sure if this is intention or a typo, but you have the r prefix in several of your templates even though you tell the reader not to put any prefixes in the version string.

meator commented 4 months ago

"Do as I say, not as I do."

You seem to be doing some proofreading (if you could call it that) of my tutorials. I am thankful for your contributions. I wish for these tutorials to become a reliable resource for working with xbps-src online. I recognize that these highly technical works are more prone to errors. I've of course tried to limit these errors to a minimum, but having a second pair of eyes, which is willing to contribute, is certainly helpful.

If you'd like to contact me more directly, I am active on Libera Chat. You might (unsurprisingly) find me at #voidlinux and #xbps. Feel free to DM me.

HiPhish commented 4 months ago

You seem to be doing some proofreading (if you could call it that) of my tutorials.

Not really, I am currently working through your tutorials because I want to learn how to properly package software for Void, and the least I can do in return is fix the things I notice along the way.

In the past I could never wrap my head around packaging for Void because the only documentation we have is the manual, but the manual mainly a reference for people who already know what they are doing. Your tutorial is perfect starting point for people like me who already know how software works, but have never had to write actual OS packages and deal with all the different quirks.

Good documentation consists of four parts: tutorials, user guides, reference and explanation. Someone even came up with a fancy name for the concept: Diataxis. Of course depending on the kind of project not all of these are applicable, but the point stands. Your tutorial is really the piece that was missing from the documentation. I think it should be merged into the Void Packages documentation eventually.