Skip to content

OPS-1673: Audit & update Integrations & Connections docs#6811

Draft
amsraman wants to merge 1 commit into
mainfrom
aditya/ops-1673-audit-update-integrations-connections-docs
Draft

OPS-1673: Audit & update Integrations & Connections docs#6811
amsraman wants to merge 1 commit into
mainfrom
aditya/ops-1673-audit-update-integrations-connections-docs

Conversation

@amsraman

Copy link
Copy Markdown
Contributor

Audit of the AI Builder integration/connection docs against the current flexgen product. Verified flows in code before editing.

Fixes in this PR (verified against code)

  • GitHub (connect_to_github.md): repo visibility is plan-dependent β€” Free repos are public, Enterprise repos are always private, Pro chooses. The old "private unless you make them public" was only true for Pro.
  • Git providers (connect_to_git_providers.md): added Azure DevOps to the supported list (it's supported via the generic git provider).
  • Database (database.md): added a "Connecting a Private or Remote Database" section (must be internet-reachable; IPv4/connection-pooler tip; Enterprise static-egress allowlisting) and noted the app connects via REFLEX_DB_URL / REFLEX_ASYNC_DB_URL (derived automatically from the single connection input).
  • Snowflake (snowflake.md): added the missing frontmatter (tags + description) β€” it had none, so its gallery card rendered without a category/subtitle.

⚠️ Needs a decision (not changed here)

  • Dead integration pages surfacing to users. The integrations gallery lists every .md in integrations-docs/docs/ (integration_list.py does an os.listdir), so airtable, hubspot, and langchain show as integrations β€” but none of them are registered in flexgen/integrations/__init__.py, so they don't exist in the product. Either remove these three pages (+ their sidebar entries) or re-register the integrations. Didn't delete unilaterally.

Still open for the ticket's DoD

  • Screenshots: couldn't refresh headless. database.md has none; the GitHub page's screenshots weren't re-verified against current UI.
  • UI navigation unverified: database.md says "Settings drawer (gear icon) β†’ Integrations tab" β€” I couldn't confirm this path against the current UI; worth a visual check.
  • Minor: the package overview.md imports from pcweb.pages... while the docs app exposes reflex_docs.pages...; verify which site consumes it.

Linear: OPS-1673

πŸ€– Generated with Claude Code

Verified the integration/connection docs against the flexgen codebase and
fixed inaccuracies:

- GitHub: repo visibility is plan-dependent (Free=public, Enterprise=private,
  Pro=choice), not "private unless you choose public".
- Git providers: Azure DevOps is supported; added it to the list.
- Database: added a "Connecting a Private or Remote Database" section
  (IPv4/pooler reachability, Enterprise static-egress allowlisting) and noted
  the app connects via REFLEX_DB_URL / REFLEX_ASYNC_DB_URL.
- Snowflake: added the missing frontmatter (tags + description) so its
  gallery card renders correctly.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@linear-code

linear-code Bot commented Jul 24, 2026

Copy link
Copy Markdown

OPS-1673

@greptile-apps

greptile-apps Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR audits and corrects four documentation files for the AI Builder integrations and connections features, fixing factual inaccuracies and filling in missing content verified against the codebase.

  • connect_to_github.md: Replaces the incorrect blanket "repositories are private unless you make them public" with plan-specific visibility rules (Free β†’ public, Pro β†’ user choice, Enterprise β†’ always private).
  • connect_to_git_providers.md: Adds Azure DevOps to the supported provider list in the body (frontmatter description and the cross-reference in connect_to_github.md still omit it β€” two one-line fixes suggested).
  • database.md: Adds a "Connecting a Private or Remote Database" section covering the internet-reachability requirement, IPv4/pooler guidance, Enterprise static-egress allowlisting, and the REFLEX_DB_URL/REFLEX_ASYNC_DB_URL env var derivation.
  • snowflake.md: Adds the missing frontmatter (tags + description) so the gallery card renders correctly.

Confidence Score: 4/5

Safe to merge β€” all changes are documentation-only with no code or config impact.

The factual corrections are well-reasoned and the PR author verified them against the codebase. The only gaps are two omissions of Azure DevOps in the frontmatter description and the cross-reference paragraph of connect_to_github.md β€” easy one-line fixes that keep the docs internally consistent.

The Azure DevOps mentions in connect_to_git_providers.md (frontmatter) and connect_to_github.md (Other Git Providers cross-reference) are the only spots worth a second look before merging.

Important Files Changed

Filename Overview
docs/ai_builder/features/connect_to_git_providers.md Added Azure DevOps to the supported providers list in the body; frontmatter description still names only GitLab and Bitbucket by example.
docs/ai_builder/features/connect_to_github.md Plan-dependent repo visibility correctly documented (Free=public, Pro=choice, Enterprise=private); cross-reference to the generic Git providers page omits Azure DevOps from its example list.
packages/integrations-docs/src/integrations_docs/docs/database.md New "Connecting a Private or Remote Database" section accurately documents IPv4/pooler requirement, Enterprise static-egress, and the REFLEX_DB_URL env var derivation.
packages/integrations-docs/src/integrations_docs/docs/snowflake.md Added missing frontmatter (tags + description), consistent with the format used in database.md; no functional changes.

Comments Outside Diff (2)

  1. docs/ai_builder/features/connect_to_git_providers.md, line 3 (link)

    P2 The frontmatter description names GitLab and Bitbucket by example but omits Azure DevOps, which was just added to the body text. A reader who only sees the gallery card or page meta won't know Azure DevOps is supported.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

  2. docs/ai_builder/features/connect_to_github.md, line 82-84 (link)

    P2 The cross-reference to the generic Git provider page lists "GitLab, Bitbucket, or a self-hosted Git server" as examples, but Azure DevOps was just added to that page as a first-class supported provider. The omission could leave Azure DevOps users unaware of the option.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Reviews (1): Last reviewed commit: "OPS-1673: audit & correct Integrations/C..." | Re-trigger Greptile

@codspeed-hq

codspeed-hq Bot commented Jul 24, 2026

Copy link
Copy Markdown

Merging this PR will degrade performance by 4.15%

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

❌ 1 regressed benchmark
βœ… 25 untouched benchmarks
⏩ 8 skipped benchmarks1

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Benchmark BASE HEAD Efficiency
❌ test_get_all_imports[_complicated_page] 2.8 ms 3 ms -4.15%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing aditya/ops-1673-audit-update-integrations-connections-docs (19f5a93) with main (052d891)

Open in CodSpeed

Footnotes

  1. 8 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

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