Add faq #178
Add faq #178
Conversation
WalkthroughThe pull request updates the ChangesFile |
Change Summary |
docs/faq.mdAdded three new FAQ entries: |
- "How to Add or Update Your Billing Email" - "Unable to View Repositories in GitLab" - "Unable to Enable Repositories in GitLab" |
Possibly related PRs
- docs: update FAQ page #152: This PR also modifies
docs/faq.md, focusing on structural and content changes, which may relate to the overall FAQ improvements. - update rate limits #185: This PR updates the "Usage Limits" section in
docs/faq.md, which is relevant to the changes made in the main PR regarding the FAQ content.
Suggested reviewers
- aravindputrevu
- alexcoderabbitai
Poem
🐰 Hop, hop, through the FAQ lane,
New questions bloom like a knowledge train!
GitLab puzzles solved with care,
Billing emails now crystal clear,
Documentation's rabbit dance, oh so rare! 📝✨
📜 Recent review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/faq.md(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/faq.md
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/faq.md (3)
84-88: Consider adding email verification detailsThe instructions are clear, but it would be helpful to mention if there's an email verification step or when the changes take effect.
Consider adding:
To add or update your billing email, navigate to the Subscription page and select Manage Subscription > **Billing Address**. Enter your email address in the -Email field and click Update to save your changes. +Email field and click Update to save your changes. You will receive a verification +email at the new address to confirm the change.
161-165: Add references to GitLab documentationConsider adding links to GitLab's official documentation about permission levels and group management for both Cloud and Self-Hosted instances.
If you cannot view repositories in the CodeRabbit UI, please ensure that you are added as a Developer in the primary group for GitLab Cloud or in the first -level group for Self-Hosted GitLab. +level group for Self-Hosted GitLab. For more information, see +[GitLab's permission documentation](https://docs.gitlab.com/ee/user/permissions.html).
167-171: Add troubleshooting steps for persistent issuesConsider adding additional troubleshooting steps for cases where users have the correct permissions but still experience issues.
If you're having trouble enabling the GitLab Repositories toggle, confirm that you have Maintainer access in the primary group for GitLab Cloud or in the first -level group for Self-Hosted GitLab. +level group for Self-Hosted GitLab. + +If you still experience issues after confirming your permissions: +1. Try logging out and back in to refresh your session +2. Clear your browser cache +3. Contact support if the issue persists
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/faq.md(2 hunks)
🔇 Additional comments (1)
docs/faq.md (1)
Line range hint 84-171: LGTM! Document structure and formatting are well-maintained
The new FAQ entries are well-organized, properly formatted, and placed in appropriate sections. The content maintains consistency with the existing document structure.
Deploying coderabbit-docs with
|
| Latest commit: |
7803e9f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7f39df18.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://add-faq.coderabbit-docs.pages.dev |
[dependabot skip]
No description provided.