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

@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 integration/connection documentation pages against the current product implementation.

  • connect_to_github.md: Replaces a one-size-fits-all visibility statement with accurate plan-dependent behavior (Free = public, Pro = user-choice, Enterprise = always private).
  • connect_to_git_providers.md: Adds Azure DevOps to the list of supported generic Git providers in the body text.
  • database.md: Adds a new "Connecting a Private or Remote Database" section covering internet-reachability requirements, IPv4/pooler guidance, Enterprise static-egress IP allowlisting, and the REFLEX_DB_URL / REFLEX_ASYNC_DB_URL env vars derived automatically from the connection input.
  • snowflake.md: Adds the previously missing frontmatter (tags + description), fixing the blank gallery card.

Confidence Score: 5/5

Pure documentation corrections with no code changes; all factual updates were verified against the codebase before editing.

All four files are Markdown documentation only. The changes correct factual inaccuracies (plan-based repo visibility, Azure DevOps support, remote database networking requirements, missing Snowflake frontmatter) and introduce no new behavior or code paths.

The "Other Git Providers" cross-reference in connect_to_github.md and the frontmatter description in connect_to_git_providers.md still omit Azure DevOps — these were flagged in previous review comments and remain open.

Important Files Changed

Filename Overview
docs/ai_builder/features/connect_to_git_providers.md Added Azure DevOps to the body text; frontmatter description still omits it (flagged in a previous comment).
docs/ai_builder/features/connect_to_github.md Updated repo-visibility text to be plan-specific (Free/Pro/Enterprise); "Other Git Providers" cross-reference still omits Azure DevOps (flagged in a previous comment).
packages/integrations-docs/src/integrations_docs/docs/database.md Added "Connecting a Private or Remote Database" section covering IPv4/pooler requirements, Enterprise static-egress allowlisting, and REFLEX_DB_URL / REFLEX_ASYNC_DB_URL derivation.
packages/integrations-docs/src/integrations_docs/docs/snowflake.md Added missing frontmatter (tags + description); fixes the gallery card rendering without a category or subtitle.

Reviews (2): 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 not alter performance

✅ 26 untouched benchmarks
⏩ 8 skipped benchmarks1


Comparing aditya/ops-1673-audit-update-integrations-connections-docs (cdbaeb0) with main (b8a4621)2

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.

  2. No successful run was found on main (b6e6420) during the generation of this report, so b8a4621 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

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>
@amsraman
amsraman force-pushed the aditya/ops-1673-audit-update-integrations-connections-docs branch from 19f5a93 to cdbaeb0 Compare July 24, 2026 19:40
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