search

coderabbitai / coderabbit-docs

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

docs: refactored integration guides images SEO and accessibility #129

Closed tyaga001 closed 3 days ago

cloudflare-workers-and-pages[bot] commented 1 week ago

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 419fd55
Status: ✅  Deploy successful!
Preview URL: https://1d6b28ad.coderabbit-docs.pages.dev
Branch Preview URL: https://docs-improve-image-seo.coderabbit-docs.pages.dev

View logs

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request includes updates to the integration documentation for CodeRabbit with various platforms: Azure DevOps, GitHub Enterprise Server, GitLab.com, and Self-Hosted GitLab. The changes primarily enhance the clarity and detail of image descriptions and instructions without altering the core integration processes. Each document now provides more context for images and steps, ensuring users better understand the integration requirements and procedures.

Changes

File Path Change Summary
docs/platforms/azure-devops.md Updated image captions for clarity; detailed descriptions for consent page and user page images.
docs/platforms/github-enterprise-server.md Expanded image descriptions; clarified instructions for submitting URLs and generating client secrets.
docs/platforms/gitlab-com.md Enhanced clarity in personal access token instructions; updated image captions for better understanding.
docs/platforms/self-hosted-gitlab.md Improved structure and clarity; emphasized setup requirements and updated visual aids for better context.

Possibly related PRs

Suggested reviewers

Poem

🐇 In the fields where rabbits play,
Clarity hops in, brightening the way.
With guides so clear, and tokens in sight,
Integrating CodeRabbit feels just right!
So let’s leap forward, with joy and cheer,
For better docs are finally here! 🌟

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