search

coderabbitai / coderabbit-docs

Official documentation of CodeRabbit: AI Code Reviews
https://docs.coderabbit.ai
7 stars 4 forks source link

docs: Improve docs SEO #142

Closed tyaga001 closed 3 days ago

coderabbitai[bot] commented 3 days ago

Walkthrough

The pull request includes updates to several integration documentation files for CodeRabbit across different platforms: Azure DevOps, GitHub Enterprise Server, GitLab.com, and Self-Managed GitLab. Each document has been refined to enhance clarity and specificity, with improvements made to the instructions, image captions, and overall structure. Key focus areas include the approval process for Microsoft Apps, detailed steps for creating OAuth Apps, and the importance of Personal Access Tokens. No changes were made to the declarations of exported or public entities.

Changes

File Change Summary
docs/platforms/azure-devops.md Updated integration instructions for Microsoft Apps consent requests, renamed images for clarity, and preserved the section on generating a Personal Access Token.
docs/platforms/github-enterprise-server.md Rephrased introductory section, clarified login and OAuth App creation steps, refined GitHub App creation instructions, and added a note on IP whitelisting.
docs/platforms/gitlab-com.md Enhanced clarity on Personal Access Token requirements, detailed steps for changing review users, and improved instructions for creating a dedicated user for CodeRabbit.
docs/platforms/self-hosted-gitlab.md Specified supported GitLab versions, refined instructions for integration, emphasized the need for an Admin Access Token, and provided detailed onboarding steps.

Possibly related PRs

Suggested reviewers

Poem

In the fields of code we hop,
With integrations that never stop.
Azure, GitHub, and GitLab too,
Clearer paths for me and you.
With tokens and guides, we leap and bound,
In the world of CodeRabbit, joy is found! 🐰✨

🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
cloudflare-workers-and-pages[bot] commented 3 days ago

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5697caf
Status: ✅  Deploy successful!
Preview URL: https://d30dba47.coderabbit-docs.pages.dev
Branch Preview URL: https://seo-changes.coderabbit-docs.pages.dev

View logs