docs: Add instructions for using GitHub fine grained PATs

[brendan-kellam]

Adds instructions for GitHub's fine grain PATs .

Summary by CodeRabbit

• Documentation
  • Expanded and reorganized GitHub authentication instructions to clarify supported token types.
  • Added detailed steps and images for both fine-grained and classic personal access tokens.
  • Improved guidance on required permissions and included links to official GitHub documentation.

[coderabbitai]

Walkthrough

The GitHub authentication documentation was expanded and reorganized to distinguish between fine-grained and classic personal access tokens. Detailed, step-by-step instructions, required permissions, and illustrative images were added for both token types, presented within an accordion UI. No code or API changes were made.

Changes

File(s)	Change Summary
docs/docs/connections/github.mdx	Expanded and restructured documentation for GitHub authentication, clarifying token types, permissions, and adding images.

Poem

🐇
In docs we burrowed deep today,
To show two token types, hooray!
Accordions open, permissions in view,
Images guide what you should do.
Whether classic or fine-grained, you see—
GitHub connections, clear as can be!

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

@brendan-kellam your pull request is missing a changelog!

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/docs/connections/github.mdx (1)

107-108: Grammar fix: “a access token” → “an access token”

Minor typo: the sentence should read “generate an access token”.

-In order to index private repositories, you'll need to generate a access token
+In order to index private repositories, you'll need to generate an access token

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ee90edc and f2bff59.

⛔ Files ignored due to path filters (1)

• docs/images/github_pat_scopes_fine_grained.png is excluded by !**/*.png

📒 Files selected for processing (1)

• docs/docs/connections/github.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build

🔇 Additional comments (1)

docs/docs/connections/github.mdx (1)

110-127: Verify images and relative paths before merging

Both images /images/github_pat_scopes_fine_grained.png and /images/github_pat_scopes.png must exist in docs/public/images (or whichever directory is served by the docs build). A missing asset will break the docs build or yield broken links at runtime.

Please double-check that the new fine-grained PAT screenshot was added in this PR (or already exists).
If it isn’t present, include it or adjust the path.