docs: Style and formatting fixes in the developer guide

[olivergondza]

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.
• [n/a] 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.
• [n/a] 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).

[bunnyshell]

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

• 🚀 /bns:deploy to deploy the environment

[olivergondza]

About the only significant change. The rest is cosmetics.

[rumstead]

Doesn't this break the markdown? Shouldn't it be [new Snyk scan weekly](../snyk/index.md)?

[olivergondza]

It does not, I have verified using make serve-docs that this fixes the problem.

Page with the link https://argo-cd.readthedocs.io/en/latest/developer-guide/release-process-and-cadence/
Old destination https://argo-cd.readthedocs.io/en/latest/developer-guide/snyk/ (404)
New destination https://argo-cd.readthedocs.io/en/latest/snyk/

[rumstead]

It breaks when rendering the markdown locally using an IDE. I believe [new Snyk scan weekly](../snyk/index.md) works in both cases. Using make serve-docs and locally in the IDE.

Screen.Recording.2025-04-22.at.9.11.53.AM.mov

Where with [new Snyk scan weekly](../../snyk) it breaks the local markdown.

[olivergondza]

Hmm, you are correct that IntelliJ IDEA fails to render it (too). What you suggest works in both, my IDE and local rendering. Another big advantage of what you suggest (always use file name/.md suffix), is that file navigation works when MD is rendered on github.com file navigator.

Tough, the docs are full of links that does not work for the same reason (they work on argo-cd.readthedocs.io). Like the 3 following:

argo-cd/docs/developer-guide/index.md

Line 10 in 06184df

## Contributing to Argo CD

.

I am sold, but lets do this across the board in separate PR. For this one link, I am ok to change it here.