docs: TI review of wiki pages and updates to readme files

[zeibura]

Not finished yet, creating this so that I can keep track of work done so far.

• Docs files up to "home.md" are finished. I'm not sure if "home.MD" needs to be proofread as it is still formatted in MediaWiki rather than in Markdown. To resume tomorrow from "libraries configuration"
• Some changes have been made to the new readme content and the readme structure (the bottom section split into two subsections and renamed configuring, as hinted by the link in a section above)
• A few minor changes to Changelog.MD

[michalbali256]

I'm not sure if "home.MD" needs to be proofread as it is still formatted in MediaWiki rather than in Markdown.

The whole documentation is published on GitHub wiki, for which are the MediaWiki references preferable over markdown references (I am not 100% sure, but I think markdown references required full url to target).

[zeibura]

The whole documentation is published on GitHub wiki, for which are the MediaWiki references preferable over markdown references (I am not 100% sure, but I think markdown references required full url to target).

Relative paths work too in Markdown, but in MW you just need the page title.

I am a bit confused then, since the rest of the pages are formatted in markdown, only home.MD is in mediawiki (and the mediawiki links don't show up properly)

[michalbali256]

All pages are formatted in markdown, only links between the pages are written using the MediaWiki syntax. I agree it may be a bit messy but at least for me it easy to use (mainly because I do not know MW syntax).

and the mediawiki links don't show up properly

They don't show up properly when viewing the sources directly, but they show up properly in GitHub wiki - that is the target platform. The docs/ folder is automatically published to wiki after each PR merge.

[zeibura]

OK, thanks for the explanation, I wasn't aware the GitHub wiki could read both formats at once

[zeibura]

All files in the root folder are now done
One rather high level point is that the page title "libraries configuration" should be "configuration of libraries". Unless this will cause any problems, I will move the page as it would be done in MediaWiki, i.e. by renaming it, and then creating a MW redirect at the old title, just in case any links to the old page remain anywhere.

[michalbali256]

Sure, go ahead with the renaming. I don't see any problems it will cause.

[zeibura]

All pages are done

[michalbali256]

I think you did a great job, thanks. I am sending several suggestions, mostly to get rid of double headings in wiki that I left there.

[zeibura]

Thansk! Just FYI, MediaWiki pipe links are [[target|link text]], not [[link text|target]]. I fixed one more.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
0 Code Smells

No Coverage information
No Duplication information

[github-actions]

🎉 This PR is included in version 0.12.0-beta.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 0.12.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀