Add branch configuration documentation for GitHub and GitLab integrations

[stephenbryant-opentrace]

Overview

This merge request introduces comprehensive documentation for configuring the synced branch for GitHub and GitLab integrations. The new sections provide clear, step-by-step instructions for changing the target branch via the UI or API, explain the re-indexing process, and clarify edge case behaviors.

Technical Details

• Files Changed:
  • docs/integrations/github.md
  • docs/integrations/gitlab.md
• Change Type: Documentation Enhancement

A new "Changing the Synced Branch" section was added to both integration documents, reflecting the shared backend mechanism and UI component (RepoSyncSettingsContent.tsx). The documentation covers:

• UI Instructions: A guide for changing the branch via the integration settings, noting that this triggers a re-indexing process.
• API Instructions: A curl example for programmatically changing the branch using the POST /v1/setup/{integrationID}/sync/{syncID} endpoint.

  curl -X POST \
    'https://{your-instance}/v1/setup/{integrationID}/sync/{syncID}' \
    --header 'Authorization: Bearer {your-token}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
      "code_branch": "your-new-branch-name"
    }'

• Documented Behaviors: Clarification on initial syncs, using custom branches, handling branch deletion, and reverting to the default branch.

Review Summary

• Key Findings: The documentation is accurate, clear, and easy to follow. API examples have been tested, and platform-specific terminology (e.g., "repository" vs. "project") is used correctly.
• Approval Status: Approved.

Impact Assessment

• Security: No security impact. This is a documentation-only change.
• Performance: No direct performance impact. The documentation correctly informs users that changing the synced branch triggers a time-consuming re-indexing process.
• Maintainability: Improves maintainability by providing clear, centralized documentation for a key integration feature, reducing potential user errors and support inquiries.

---

Attached by run b614fcd9-6fbb-4d1c-aa23-609fd9f53a54

[github-actions]

📚 Documentation Preview

Preview deployed to: https://opentrace.github.io/docs/preview/18-merge/

[opentrace]

Approved

[opentrace]

This merge request adds valuable and comprehensive documentation for configuring synced branches in both GitHub and GitLab integrations. The changes are well-documented, low-risk, and improve the user experience by providing clear instructions for a key feature.

---

Attached by run j-89bb7386-47de-4abd-a3d2-5079817ccb99

[opentrace]

The merge request adds valuable and comprehensive documentation for configuring the synced branch in both GitHub and GitLab integrations. The changes are well-described, cover both UI and API methods, and explain important behaviors and edge cases. This is a low-risk, high-value addition to the project's documentation.

---

Attached by run j-6614979b-b202-4236-9239-c6f51e6d6709

[opentrace]

Approved

[opentrace]

Approved

[opentrace]

This is a high-quality documentation enhancement that adds clear and comprehensive instructions for configuring synced branches in GitHub and GitLab. The changes have been reviewed, tested, and have no negative impact on security or performance.

---

Attached by run j-1d27922e-8c77-4d48-9b04-d2979c0f03f4

[opentrace]

Approved

[opentrace]

This merge request adds valuable and well-written documentation for configuring the synced branch in GitHub and GitLab integrations. The changes are clear, cover both UI and API instructions, and appropriately warn users about the re-indexing process. As a documentation-only change, it has no security or performance impact and improves the overall user experience.

---

Attached by run b614fcd9-6fbb-4d1c-aa23-609fd9f53a54