8000 replace old example prompt by alexcoderabbitai · Pull Request #247 · coderabbitai/coderabbit-docs · GitHub
[go: up one dir, main page]
Skip to content

replace old example prompt #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 11, 2025
Merged

replace old example prompt #247

merged 2 commits into from
Mar 11, 2025

Conversation

alexcoderabbitai
Copy link
Collaborator

No description provided.

@alexcoderabbitai alexcoderabbitai enabled auto-merge (squash) March 11, 2025 17:19
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Mar 11, 2025 •
edited
Loading

Walkthrough

The documentation has been updated to remove a backtick (`) at the beginning of a line in the example prompt section of the custom reports guide. This change modifies the formatting of the example prompt, transitioning it from code formatting to standard text. No changes were made to any exported or public entities.

Changes

File Change Summary
docs/guides/custom-reports.md Removed a backtick at the beginning of a line in the example prompt section, changing the formatting from code to standard text.

Possibly related PRs

  • 🎨 Run Markdownlint and Prettier #84: The changes in the main PR, which involve a minor formatting adjustment in a markdown document, are related to the formatting changes made in this PR, which also focuses on similar markdown formatting improvements across various documentation files.

Suggested labels

documentation

Poem

I'm a rabbit on a coding spree,
Hopping through documentation with glee,
A backtick gone, a line set free,
Formatting brightens, can't you see?
With every change, I hop with glee!

(_/)

🪧 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 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.

@cloudflare-workers-and-pages Cloudflare Workers and Pages
Copy link
cloudflare-workers-and-pages bot commented Mar 11, 2025 •
edited
Loading

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f45a9e3
Status: ✅  Deploy successful!
Preview URL: https://d6da2447.coderabbit-docs.pages.dev
Branch Preview URL: https://fix-replace-old-custom-examp.coderabbit-docs.pages.dev

View logs

@alexcoderabbitai alexcoderabbitai enabled auto-merge (squash) March 11, 2025 17:22
coderabbitai[bot]
coderabbitai bot reviewed Mar 11, 2025
View reviewed changes
Copy link
Contributor
@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 (1)
docs/guides/custom-reports.md (1)

118-119: Remove Unintended Backtick in Prompt Example

It appears the leading backtick on line 118 is no longer desired as per the updated instructions for the example prompt. Removing it will ensure that the line is rendered as plain text rather than as a code snippet.

-`Use the <overall_instructions> to guide the content of the summary. Use the format shown in <example> but do not include or refer the example's content in the final summary/report.
+Use the <overall_instructions> to guide the content of the summary. Use the format shown in <example> but do not include or refer the example's content in the final summary/report.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 31063ec and f45a9e3.

📒 Files selected for processing (2)
  • docs/guides/custom-reports.md (1 hunks)
  • docs/guides/custom-reports.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/guides/custom-reports.md
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Cloudflare Pages

@alexcoderabbitai alexcoderabbitai merged commit 6104efb into main Mar 11, 2025
4 checks passed
@alexcoderabbitai alexcoderabbitai deleted the fix/replace-old-custom-example branch March 11, 2025 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@alexcoderabbitai
0