fix: add guardrail test for unescaped markdown in command descriptions

[mwbrooks]

Changelog

• N/A

Summary

This pull request adds a guardrail to prevent unescaped markdown characters from breaking the documentation website build.

After #547 revealed that unescaped { and [ in command descriptions can break the Docusaurus MDX build, this adds:

• A unit test that walks all commands and validates their Long descriptions render correctly through the same text/template logic used by docgen
• CLAUDE.md guidance so contributors know to escape { and [ in descriptions

Preview

• N/A

Testing

• Update cmd/api/api.go to remove the escaped \\{ to be { in the Long description.
• Run make test.
• Confirm tests fail.

--- FAIL: Test_CommandDescriptionsRenderForDocs (0.01s)
    --- FAIL: Test_CommandDescriptionsRenderForDocs/cmd.test_api (0.00s)
make: *** [test] Error 1

Notes

• Placed in cmd/root_test.go because the test needs Init() to build the full command tree - putting it in cmd/docgen/ would create a circular import

Requirements

• I've read and understood the Contributing Guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.64%. Comparing base (d682c81) to head (7325892).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #549   +/-   ##
=======================================
  Coverage   71.64%   71.64%           
=======================================
  Files         225      225           
  Lines       19074    19074           
=======================================
  Hits        13665    13665           
  Misses       4202     4202           
  Partials     1207     1207           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[zimeg]

@mwbrooks LGTM! This is a super neat test to include 🧪 📚 ✨

Please merge when correct but I'm now thinking of similar checks we can include for the outputs of help command?

[mwbrooks]

@zimeg Thanks for the quick review! 🙌🏻

Feel free to follow-up for deeper checks. We could add it for Short and Example as well, but I figured the high impact is Long.