Skip to content

docs: improve connection docs to be more clear#982

Merged
brendan-kellam merged 1 commit intomainfrom
brendan/improve-auth-docs-examples
Mar 5, 2026
Merged

docs: improve connection docs to be more clear#982
brendan-kellam merged 1 commit intomainfrom
brendan/improve-auth-docs-examples

Conversation

@brendan-kellam
Copy link
Contributor

@brendan-kellam brendan-kellam commented Mar 5, 2026

Summary

  • Replaces the vague // .. rest of config .. placeholder in authentication code examples across all connection docs with explicit, commented-out repo selection fields
  • Users reading only the auth section can now see what fields are required to actually sync repos, without having to cross-reference the examples section
  • Active option in each example is the most specific selector (repos), with broader options commented out

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated connection configuration examples across Azure DevOps, Bitbucket, Gerrit, Gitea, GitHub, and GitLab to include explicit guidance on specifying repositories and projects to sync.
    • Enhanced example configurations with clearer field specifications and requirements, making setup instructions more straightforward and reducing ambiguity.

…lds in auth examples

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5435c365-3434-47d4-9e96-316b2c4ccedb

📥 Commits

Reviewing files that changed from the base of the PR and between 29c93e6 and 9675bd9.

📒 Files selected for processing (8)
  • docs/docs/connections/ado-cloud.mdx
  • docs/docs/connections/ado-server.mdx
  • docs/docs/connections/bitbucket-cloud.mdx
  • docs/docs/connections/bitbucket-data-center.mdx
  • docs/docs/connections/gerrit.mdx
  • docs/docs/connections/gitea.mdx
  • docs/docs/connections/github.mdx
  • docs/docs/connections/gitlab.mdx

Walkthrough

Documentation updates across multiple cloud platform connection files to add explicit "repos" or "projects" fields to configuration examples, clarifying which repositories or projects must be specified for synchronization. Changes include field additions, example values, and explanatory comments throughout Azure DevOps, Bitbucket, Gerrit, Gitea, GitHub, and GitLab connection documentation.

Changes

Cohort / File(s) Summary
Azure DevOps
docs/docs/connections/ado-cloud.mdx, docs/docs/connections/ado-server.mdx
Added explicit "repos" field with example value and comments to configuration examples, replacing generic placeholder endings.
Bitbucket
docs/docs/connections/bitbucket-cloud.mdx, docs/docs/connections/bitbucket-data-center.mdx
Added "repos" field with example values across multiple authentication method examples; includes clarifying comments on required repo specification.
Gerrit
docs/docs/connections/gerrit.mdx
Introduced new "projects" property with glob pattern example to specify which projects to sync in configuration snippet.
Gitea
docs/docs/connections/gitea.mdx
Added explicit "repos" field with example values and commented alternatives (orgs, users) to environment token and custom connection examples.
GitHub
docs/docs/connections/github.mdx
Added "repos" field with example values and commented alternatives (orgs, users) across multiple authentication scenarios (env token, PAT, custom host).
GitLab
docs/docs/connections/gitlab.mdx
Added "projects" array field with examples to token and URL configuration blocks; updated comments to reflect new required field option.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

sourcebot-team

Suggested reviewers

  • msukkari
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch brendan/improve-auth-docs-examples

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@brendan-kellam brendan-kellam changed the title docs: replace '.. rest of config ..' with explicit repo selection fields docs: improve connection docs to be more clear Mar 5, 2026
@brendan-kellam brendan-kellam merged commit 0504da2 into main Mar 5, 2026
8 of 9 checks passed
@brendan-kellam brendan-kellam deleted the brendan/improve-auth-docs-examples branch March 5, 2026 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant