Page 1 of 1

Editing the documentation

Posted: Mon Jul 26, 2021 6:25 am
by Monospace
The LMMS documentation at docs.lmms.io has many spelling errors etc, and I would like to correct them. There are also one or two dead links to sample files, and I happen to have downloaded these files back when the links still worked. Dead outlinks also can be replaced by archived versions or added on to by better explanation links.
I am asking, is there any way to edit the documentation?

Re: Editing the documentation

Posted: Mon Jul 26, 2021 3:07 pm
by musikbear
Monospace wrote: โ†‘
Mon Jul 26, 2021 6:25 am
The LMMS documentation at docs.lmms.io has many spelling errors etc, and I would like to correct them. There are also one or two dead links to sample files, and I happen to have downloaded these files back when the links still worked. Dead outlinks also can be replaced by archived versions or added on to by better explanation links.
I am asking, is there any way to edit the documentation?
documentation at docs.lmms.io
Do you mean:
https://docs.lmms.io/[b]user-manual/[/b]
Or is it the DEV-pages?
https://docs.lmms.io/user-manual/ is brand new. The git-book
It should have been through a quality check, afaik..
Could you point out an example of the mistakes?
Anywitch It is liushuyu who is "chief of docs" so you can ask him to get editing-privilege.

Re: Editing the documentation

Posted: Mon Jul 26, 2021 4:21 pm
by Monospace
It should have been through a quality check, afaik..
I don't doubt it has been, but some things can escape.
My best example is the Opulenz page: https://docs.lmms.io/user-manual/5-buil ... 10-opulenz
There are a few minor places where the phrasing hasn't been as good as it could have been. Example:
OpulenZ is an emulation of the Yamaha YM3812, a.k.a. OPL2, FM synth chip which was used i sound cards around 1990 - the Adlib and Sound Blasters.
Could be
"OpulenZ is an emulation of the Yamaha YM3812, also known as the OPL2, an FM synth chip which was used in sound cards around 1990- like the Adlib and Sound Blasters."
You'll realise my suggestions aren't major. They're simply minor improvements that do nothing obvious, but improve overall readability and grammatical appearance of the text.
Also, at the end of the Opulenz page,
That's a broken outlink. It needs to be replaced with an archive.org outlink, or a better explanation.
Also, there are a few other places in the documentation which have broken links or poorly grammaticized content. This can be cleaned only with a full and careful examination/reading of the docs, or by multiple people cleaning up something each time they find it can be done better.
Anywitch It is liushuyu who is "chief of docs" so you can ask him to get editing-privilege.
Is Liushuyu a forum user? I will look into it. Thanks, musikbear!
Edit: how do I get in contact with Liushuyu?

Re: Editing the documentation

Posted: Tue Jul 27, 2021 3:38 pm
by musikbear
Monospace wrote: โ†‘
Mon Jul 26, 2021 4:21 pm
My best example is the Opulenz page:
Also, at the end of the Opulenz page,
:
Getting started with FM: http://www.gorenfeld.net/lou/fmguide.html
Good finds
Edit: how do I get in contact with Liushuyu?
I have asked him to contact you.

Re: Editing the documentation

Posted: Wed Jul 28, 2021 2:41 pm
by musikbear
liushuyu says that you should be able to edit..
Apparently everyone should
I d k ..๐Ÿคจ

Re: Editing the documentation

Posted: Wed Jul 28, 2021 3:41 pm
by Monospace
Musikbear, can you ask him how to edit the documentation? I do not see any clearly labelled "Edit" button in my sight...

Re: Editing the documentation

Posted: Fri Jul 30, 2021 3:31 pm
by musikbear
Monospace wrote: โ†‘
Wed Jul 28, 2021 3:41 pm
Musikbear, can you ask him how to edit the documentation? I do not see any clearly labelled "Edit" button in my sight...
will do

Re: Editing the documentation

Posted: Sat Jul 31, 2021 3:49 pm
by musikbear
musikbear wrote: โ†‘
Fri Jul 30, 2021 3:31 pm
Monospace wrote: โ†‘
Wed Jul 28, 2021 3:41 pm
Musikbear, can you ask him how to edit the documentation? I do not see any clearly labelled "Edit" button in my sight...
will do
I asked him to contact you here. Keep an eye on your PMs