Skip to content

Conversation

@kolipakakondal
Copy link
Collaborator

@kolipakakondal kolipakakondal commented Apr 7, 2025

Description

Documenation update based on the users request

Type of change

  • This change requires a documentation update

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • Documentation
    • Added a new section providing guidance on configuring code formatting in projects.
    • Explained that previous legacy formatter files aren’t directly supported with current tools.
    • Offered instructions for auto-generating default formatting settings for new projects and manual setup for existing ones.
    • Included additional options and references for users seeking to mirror their previous formatting preferences.

@coderabbitai
Copy link

coderabbitai bot commented Apr 7, 2025

Walkthrough

The documentation has been updated with a new section in the FAQs that explains why old C/C++ editor formatter files (.xml) are not compatible with current ESP-IDF projects. It details how ESP-IDF now relies on Clangd and the need for a .clang-format file. Instructions include generating a default .clang-format file using clang-format -style=llvm -dump-config > .clang-format, and manual instructions for existing projects, along with guidance for replicating legacy settings.

Changes

File Change Summary
docs/en/faqs.rst Added a section on the incompatibility of old .xml formatter files with ESP-IDF projects, detailing the requirement for a .clang-format file, automated creation for new projects, manual configuration for existing ones, and options for converting settings including AI-assisted mapping.

Possibly related PRs

Poem

I’m a rabbit with a bounce in my stride,
Hopping through docs with updates wide.
Old XML files must now retire,
.clang-format brings the new fire.
With commands and tips, our steps are light—
Tech carrots shine so ever bright!
🥕🐇


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/en/faqs.rst (2)

173-176: Appropriate Code Block for Command Usage.
The use of the .. code-block:: none directive to present the command is clear. For enhanced readability, consider switching to a shell-specific code block (e.g., .. code-block:: bash) to benefit from syntax highlighting.


183-187: Polish Bullet List Formatting for Replicating Old Settings.
The bulleted list offers practical options for users who want to replicate their old formatter settings. To improve readability, consider revising the line:

  • From: "Or Use an AI tool(e.g: ChatGPT) to assist in converting your old configuration to the new one and then manually adjust if there are any discrepancies."
  • To: "Or use an AI tool (e.g., ChatGPT) to assist in converting your old configuration to the new format and then manually adjust for any discrepancies."
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 57b433d and 9c32662.

📒 Files selected for processing (1)
  • docs/en/faqs.rst (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build_macos
🔇 Additional comments (4)
docs/en/faqs.rst (4)

167-168: New FAQ Entry Title & Underline Formatting Correct.
The new FAQ question is clearly stated and the underline (using dashes) follows RST conventions well.


169-172: Clear Explanation of Incompatibility and Suggested Action.
The text effectively explains that the old .xml (CDT formatter) files cannot be used with ESP-IDF projects now relying on Clangd, and it guides users on generating a default .clang-format file. This section is concise and aligns with the documentation’s tone.


177-182: Clear Differentiation Between New and Existing Projects.
The instructions clearly delineate that in new ESP-IDF projects the .clang-format file is auto-generated while for existing projects it must be created manually (via “ESP-IDF > Create Clangd File”). This provides users with straightforward guidance depending on their project type.


188-189: Valuable External References Provided.
The inclusion of links to the Clang Format documentation and formatting style options will help users seeking more detailed guidance.

@kolipakakondal kolipakakondal merged commit 3c512b8 into master Apr 7, 2025
6 of 7 checks passed
@kolipakakondal kolipakakondal deleted the clangd_docs_update branch April 7, 2025 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants