Updated coderabbit rules

[krofax]

Description Updated CodeRabbit rules to:

1. Proper Noun Preservation: Proper nouns like "Optimism", "OP Mainnet", and "Ethereum" will now retain their capitalization in headers (H1, H2, H3), even with sentence case.

2. Manual Flagging for Edge Cases: Any headers that don’t follow these rules exactly will be flagged for manual review to avoid false positives.

Tests

Additional context

Metadata

[netlify[bot]]

✅ Deploy Preview for docs-optimism ready!

Name	Link
🔨 Latest commit	d703984b8a7640acc2ffc90d9d0df963aecc8dbb
🔍 Latest deploy log	https://app.netlify.com/sites/docs-optimism/deploys/6720fed9e0b69600087c46ff
😎 Deploy Preview	https://deploy-preview-974--docs-optimism.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request primarily involve updates to the .coderabbit.yaml configuration file, specifically in the path_instructions section. The modifications clarify the guidelines for reviewing Markdown content, particularly regarding the use of title case and header formatting. New rules for headers have been introduced, and a mechanism for flagging inconsistencies has been added. Additionally, the nouns.txt file has been updated to include new terms related to blockchain technology and decentralized finance.

Changes

File	Change Summary
.coderabbit.yaml	Updated path_instructions to refine title case guidelines and expand header formatting rules. Added instructions for flagging inconsistent header applications. Minor formatting adjustments in other sections.
nouns.txt	Updated to include additional terms related to blockchain technology: Optimism, OP Mainnet, Ethereum, OP Stack, and MetaMask.

Possibly related PRs

• #946: This PR focuses on applying sentence casing to all headers, which aligns with the changes made in the main PR regarding header capitalization rules.
• #945: The style guide update in this PR includes clarifications on formatting and structuring content, which relates to the main PR's modifications to the .coderabbit.yaml configuration file for Markdown content review.
• #900: Although this PR primarily addresses wording in documentation, it reflects a similar focus on improving clarity and consistency in documentation practices, which is a goal of the main PR's changes.
• #928: This PR introduces a notice about SDK deprecation, which may involve similar documentation standards and guidelines as those refined in the main PR.
• #972: The consistency in terminology and formatting addressed in this PR is relevant to the main PR's focus on standardizing header rules and guidelines.
• #988: This PR's title case update for the Supersim page is directly related to the main PR's changes regarding capitalization rules for headers.

Suggested reviewers

• cpengilly
• bradleycamacho

---

📜 Recent review details

Configuration used: .coderabbit.yaml Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 15c6cd3c36a32524dae6fa8dfa1b9d4dd3662845 and d703984b8a7640acc2ffc90d9d0df963aecc8dbb.

📒 Files selected for processing (1)

• nouns.txt (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• nouns.txt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cpengilly]

@krofax confirmed with product that we should use this file as source of truth for all product names. perhaps we can write a script to import them directly? not sure if there's a way to automate it. ❤️