[Doc] Update documentation

[nephros]

No functional/code changes, adds some improved documentation comments.

[Olf0]

Oh, that is a lot! Will try to review this weekend.

[nephros]

Oh, that is a lot! Will try to review this weekend.

I could split this up in e.g. separate PRs for each "module", i.e. on for the daemon, one for the UI etc. If that makes things more palpable.
Then again, most of it is in the daemon source so it probably wouldn't make a whole lot of difference.

Also:

• as source code documentation, almost no-one is ever going to read most of this. :)
• comments are my analysis and understanding of the code. There are likely to be incorrect parts if I misunderstood something.

I mean to say, don't sweat it with the details.
Once this is in, I plan to correct any errors in a fly-by manner, i.e. when actual code in the vicinity or context of the doc comment is changed.
But in order to do that we need this in first obviously.

[Olf0]

I could split this up in e.g. separate PRs for each "module", i.e. on for the daemon, one for the UI etc. If that makes things more palpable.

Rather the opposite: I just want to read all this in its current state, splitting it up will make it less digestible for this task.

* as source code documentation, almost no-one is ever going to read most of this. :)

Me, at least once. :-)

* comments are my analysis and understanding of the code. There are likely to be incorrect parts if I misunderstood something.

Don't be afraid, I will not be able to detect them. ;-)
But by reading it once, I can spot typos, ambiguous statements and the overall structure.

Once this is in, I plan to correct any errors in a fly-by manner, i.e. when actual code in the vicinity or context of the doc comment is changed.

But with these changes, I will never review the documentation as whole, again; hence I will never be able to look at its overall structure, again.

[nephros]

I will never be able to look at its overall structure, again.

It will likely make the task easier to look through

https://nephros.github.io/patchmanager/patchmanager/

it is the result of this workflow run which should be the version in this PR:
https://github.com/nephros/patchmanager/actions/runs/12073460974

EDIT: playing around with stylesheets. the link above may change appearance, content is unchanged.

[nephros]

Please forgive my rudeness of pushing "unrelated" changes, but I like my Patchmanger-Corporate-Identity CSS, and the defaults are worse than this.