docs: add high-level overview of regzbot

[alanpeixinho]

Description

I’ve added documentation to provide high level context (targeted at new collaborators) on how Regzbot operates under the hood.

Summary:

• Added a high-level overview covering the bot's core logic and email-command parsing.
• Documented the relationship between tracked Git trees (Mainline/Next/Stable).
• Included a Codebase Organization table to help contributors navigate the Python modules.
• Mapped out the pluggable report sources (GitHub, GitLab, Bugzilla, Lore).

[tales-aparecida]

LGTM no notes

[tales-aparecida]

@alanpeixinho pls add you sign off in the commit

[knurd]

So, on one hand this is great. It thus should be mentioned in README.md so that people find it – a file that also prominently mentions docs/getting_started.md as a starting point. Which leads to the question: do we really need three documents for this, that in parts overlap?

Maybe we need three documents -- or four, if you count docs/reference.md, which we should not forget there:

• README.md
• one document for "people that want to just get their kernel regression tracked" (maybe that should primarily link to the kernel docs?)
• one document for that is a mix of docs/getting_started.md and the text submitted here
• docs/reference.md

Or what do others think?

[alanpeixinho]

So, on one hand this is great. It thus should be mentioned in README.md so that people find it – a file that also prominently mentions docs/getting_started.md as a starting point. Which leads to the question: do we really need three documents for this, that in parts overlap?

Maybe we need three documents -- or four, if you count docs/reference.md, which we should not forget there:

• README.md
• one document for "people that want to just get their kernel regression tracked" (maybe that should primarily link to the kernel docs?)
• one document for that is a mix of docs/getting_started.md and the text submitted here
• docs/reference.md

Or what do others think?

Good point, @knurd. I felt that friction too when deciding where to put this. I’m totally on board with consolidating these to reduce bloat in docs. Do you think splitting this content between the README.md and getting_started.md is cleaner?

[knurd]

Do you think splitting this content between the README.md and getting_started.md is cleaner?

From a quick look I guess most of the stuff should go into those files. Maybe there are bits that are best put into the reference docs, too. And stuff like "Codebase organization" maybe should go to CONTRIBUTING.md (or a new file that is meant for developers, but I doubt one will be needed).

Overall use your best judgement – and when you get a "this doesn't fit well" feeling or something like that really just ping me to discuss things in a chat, that might be easier for both of us that doing it here .