Skip to content

improvement(docs): standardize integration copy and generated references - #9039

Merged
waleedlatif1 merged 5 commits into
stagingfrom
codex/integration-docs-audit
Oct 14, 2026
Merged

waleedlatif1 merged 5 commits into
stagingfrom
codex/integration-docs-audit

Conversation

@waleedlatif1

@waleedlatif1 waleedlatif1 commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Audit all 306 integration pages, rewrite repetitive copy at its canonical owner, and preserve setup details and complete reference tables.
  • Move connection requirements before actions, standardize headings while preserving anchors, and group Sportmonks by its existing API families.
  • Correct misleading credential, billing, asynchronous, and destructive-operation claims; document existing compatibility gaps.
  • Preserve search citation URLs and clean result titles for explicit heading IDs.
  • Add integration editorial guidance and a complete page ledger; remove unused FAQ code/styles and improve integration table wrapping.

Type of Change

  • Improvement
  • Bug fix

Testing

Root lint, type-check, all 60 audits, and block-registry checks. Deterministic double regeneration; all 114,323 generated table rows and 5,996 reference headings preserved, with six documented Circleback meeting-ID type corrections. All 18,866 existing integration anchors retained; 1,995 internal links and 97 inbound anchors checked. All 306 pages verified over HTML and Markdown, with asset and regression checks. Production docs build and responsive browser QA. Independent before/after copy reviews and structural comparisons preserve tool/catalog identities, parameters, defaults, scopes, and execution logic. Ten existing/added parser checks pass; custom-heading regressions fail before the fix and when either ID preservation or label cleanup is removed. Full suites run in CI. Live provider accounts were not exercised.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing (new parser regressions pass the test-audit authoring gate)
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 14, 2026 10:44pm UTC

Request Review

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 641 files

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.

Turn on auto-fix | Re-trigger cubic

Comment thread apps/sim/blocks/blocks/affinity.ts Outdated
Comment thread apps/sim/blocks/blocks/microsoft_teams.ts Outdated
Comment thread apps/sim/blocks/blocks/gong.ts Outdated
Comment thread apps/sim/blocks/blocks/logs.ts Outdated
Comment thread apps/sim/blocks/blocks/managed_agent.ts Outdated
Comment thread apps/sim/blocks/blocks/dropbox.ts Outdated
Comment thread apps/sim/blocks/blocks/quartr.ts Outdated
Comment thread apps/sim/blocks/blocks/dub.ts Outdated
Comment thread apps/sim/blocks/blocks/servicenow.ts Outdated
Comment thread apps/sim/blocks/blocks/intercom.ts Outdated
@greptile-apps

greptile-apps Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no new blocking issue was established.

Summary

Standardizes integration copy at its source and regenerates the references and public catalog.

  • Integration guides explain setup and provider behavior more clearly.
  • Generated integration pages put setup first and group actions more clearly.
  • Search citations keep stable heading links without showing ID aliases.
  • Integration editing guidance is added and unused FAQ material is removed.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  A[Block, tool, trigger, and OAuth descriptions] --> B[Docs generator]
  C[Authored setup and notes] --> B
  B --> D[Integration references]
  B --> E[Public catalog]
  D --> F[DocsChunker]
  F --> G[Search titles and section links]
Loading

Reviews (6) · Last reviewed commit: "fix(docs): preserve explicit search head..." · Reviewed by Greptile

@waleedlatif1
waleedlatif1 force-pushed the codex/integration-docs-audit branch from a3c72b9 to 82ed905 Compare October 14, 2026 21:01
@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 641 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.

Turn on auto-fix | Re-trigger cubic

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

Comment thread apps/sim/triggers/microsoftteams/chat_webhook.ts Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 645 files

Confidence score: 5/5

  • In apps/sim/blocks/blocks/dropbox.ts, longDescription says the block can search folders, but the search operation searches files. Update the description to match.
Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="apps/sim/blocks/blocks/dropbox.ts">

<violation number="1" location="apps/sim/blocks/blocks/dropbox.ts:23">
P3: `longDescription` says the block can "search folders", but the search operation (`dropbox_search`, labelled "Search Files") queries file content by `query`, `path`, and `fileExtensions`. Change "list and search folders" to "list folders and search files".</violation>
</file>

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.

Turn on auto-fix | Re-trigger cubic

Comment thread apps/sim/blocks/blocks/affinity.ts Outdated
Comment thread apps/sim/blocks/blocks/dropbox.ts Outdated
@waleedlatif1
waleedlatif1 force-pushed the codex/integration-docs-audit branch from c7d1b6b to e97f917 Compare October 14, 2026 21:48
@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 645 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.
You've manually re-run cubic several times on this PR. Each manual re-review checks the full PR again and counts toward your usage quota. To preserve your usage limits, we recommend letting cubic automatically review new commits.

Turn on auto-fix | Re-trigger cubic

Comment thread apps/docs/content/docs/integrations/table.mdx Outdated
@waleedlatif1
waleedlatif1 force-pushed the codex/integration-docs-audit branch from e97f917 to 9db1767 Compare October 14, 2026 22:15
@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 645 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.
You've manually re-run cubic several times on this PR. Each manual re-review checks the full PR again and counts toward your usage quota. To preserve your usage limits, we recommend letting cubic automatically review new commits.

Turn on auto-fix | Re-trigger cubic

Comment thread scripts/generate-docs.ts
@waleedlatif1
waleedlatif1 force-pushed the codex/integration-docs-audit branch from 9db1767 to 098445c Compare October 14, 2026 22:39
@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 647 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Note: This PR contains a large number of files. cubic selects up to 200 of the highest-priority eligible files for this review, so some files may not have been reviewed.
You've manually re-run cubic several times on this PR. Each manual re-review checks the full PR again and counts toward your usage quota. To preserve your usage limits, we recommend letting cubic automatically review new commits.

Turn on auto-fix | Re-trigger cubic

@waleedlatif1
waleedlatif1 merged commit a754780 into staging Oct 14, 2026
43 of 44 checks passed
@waleedlatif1
waleedlatif1 deleted the codex/integration-docs-audit branch October 14, 2026 22:46

This branch was successfully deployed

1 active deployment
Preview — 098445cc Deployed Oct 14, 2026 by vercel[bot]
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