Add FAQ section and installation details for GitHub App integration

[hasit]

No description provided.

[coderabbitai]

Walkthrough

The documentation for integrating CodeRabbit with GitHub Enterprise Server was updated to include a new instruction about setting the GitHub App installation scope to "Any account" and to add a new FAQ section covering app creation responsibilities and troubleshooting login errors.

Changes

File	Change Summary
docs/platforms/github-enterprise-server.md	Added instruction for GitHub App installation scope and introduced a new FAQ section.

Poem

🐇
In docs we hop, a scope to set,
"Any account"—don’t forget!
FAQs bloom at the page’s end,
Helping every user mend.
With guidance clear and errors few,
CodeRabbit’s here to help you through!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 375f468 and a8c2e3a.

📒 Files selected for processing (1)

• docs/platforms/github-enterprise-server.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/platforms/github-enterprise-server.md

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch hasit/github-self-hosted
• Post Copyable Unit Tests in Comment

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/platforms/github-enterprise-server.md (1)

174-189: Enhance FAQ with grammatical and linkage improvements.

• Change “Clear your browser local storage” to “Clear your browser’s local storage” for grammatical accuracy.
• Convert “contact our support team” into a clickable link (e.g., mailto:contact@coderabbit.ai or a support page URL) to streamline user action.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 002a4b4 and 375f468.

⛔ Files ignored due to path filters (2)

• static/img/integrations/login-self-hosted-github.png is excluded by !**/*.png, !**/*.png
• static/img/integrations/self-hosted-github-host-url.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (1)

• docs/platforms/github-enterprise-server.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: test
• GitHub Check: Cloudflare Pages

🔇 Additional comments (1)

docs/platforms/github-enterprise-server.md (1)

114-114: GitHub App installation scope instruction is correct.
The new bullet clearly directs users to set “Where can this GitHub App be installed?” to Any account, which matches GitHub Enterprise Server’s UI.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	a8c2e3a
Status:	✅  Deploy successful!
Preview URL:	https://d2c398ea.coderabbit-docs.pages.dev
Branch Preview URL:	https://hasit-github-self-hosted.coderabbit-docs.pages.dev

View logs