Improve Code Rabbit docs prompt

[mvandeberg]

Summary by CodeRabbit

• Chores
  • Updated internal code review documentation guidance and standards for C++ headers to ensure comprehensive and consistent documentation practices.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Updated the path_instructions configuration block in .coderabbit.yaml to establish more comprehensive documentation requirements for public-facing C++ headers, including guidance on parameter documentation, return values, preconditions, postconditions, and exception specifications.

Changes

Cohort / File(s)	Summary
Configuration documentation guidelines \.coderabbit\.yaml	Enhanced path_instructions for C++ headers with stricter docstring requirements (parameters, return values, pre/postconditions, templated parameters, thread-safety, exceptions) and added guidance for high-level block comments

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Add Code Rabbit AI config #254: Modifies the same .coderabbit.yaml path_instructions block for C++ header documentation standards.

Poem

🐰 Docs so clear, with rabbits we cheer,
Headers now shine with details sincere,
Parameters, returns, all laid out clean,
The finest C++ code ever seen! ✨

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: updating the Code Rabbit configuration documentation prompts to be more comprehensive.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}