docs: rewrap comments in code blocks to not overflow on desktop

[aogier]

Checklist:

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
• The title of the PR states what changed and the related issues number (used for the release note).
• The title of the PR conforms to the Toolchain Guide
• I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
• I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
• Does this PR require documentation updates?
• I've updated documentation as required by this PR.
• I have signed off all my commits as required by DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My build is green (troubleshooting builds).
• My new feature complies with the feature status guidelines.
• I have added a brief description of why this PR is necessary and/or what this PR solves.
• Optional. My organization is added to USERS.md.
• Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

This PR is a QoL fix for documentation accessed from a desktop machine.
As of now, code blocks have a lot of horizontal overflows:

some of them are very unfortunate (comment states "... except for Deployment and StatefulSet"):

What I've did is to rewrap all overflowing comments in yaml code blocks so every valuable comment/note is on screen. Blocks still overflow when there are lengthy code rows, my rationale is this isn't too much a problem as if you're studying you want to read the comments and then copy the code for further analysis.

What do you think? I've suffered a lot when I first studied Argo CD so I hope this small change will improve the lives of those who will follow me :)

thank you, regards

[andrii-korotkov-verkada]

Thanks! Can you rebase just in case, please?

[aogier]

Hi, I've just rebased it including latest changes!

It's a huge PR, sorry for that, I'm open for suggestion on how to split in smaller chunks should it makes sense.

Thank you, regards

[andrii-korotkov-verkada]

I think it's fine, since most changes are comment rewrap. Just make CI pass.

[aogier]

I fixed the CI by reverting a single line that was basically not of much value, I think it's all set :)