Skip to content

improvement(docs): refine screenshots, copy, and API interactions - #9269

Merged
waleedlatif1 merged 3 commits into
stagingfrom
codex/docs-polish
Oct 21, 2026
Merged

waleedlatif1 merged 3 commits into
stagingfrom
codex/docs-polish

Conversation

@waleedlatif1

@waleedlatif1 waleedlatif1 commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Replace dated documentation screenshots with current Chat and resource views on Sim's grayscale backgrounds. Standardize overview crops, focused details, and the media viewer.

  • Tighten Getting started, Files, Chat, desktop, integration, and reference copy while preserving setup requirements, limits, and field details. Fold long integration tables into searchable native disclosures through the generator.

  • Keep API language samples mounted for faster switching, simplify authentication labels and navigation, refine spacing, and retain the existing consistent article and navigation font.

  • Replace the marketing footer directory with a compact documentation footer for status, source, updates, help, and legal links.

Type of Change

  • Improvement

Testing

  • The integration generator refreshes its tool metadata dependency before reading it; a stale-input probe confirms check mode fails without writes, normal generation repairs it, and all 321 tracked outputs remain unchanged on repetition.
  • Targeted formatting and the commit hook pass; generated integration/OpenAPI output is unchanged on a second run across 317 files.
  • Current-source previews compile 26 representative pages. Browser checks cover screenshot framing, narrow layouts, matching font families, API language/authentication/response controls, endpoint navigation, and media-viewer zoom, dismissal, and focus restoration.
  • Final PR CI passed: production builds, docs HTTP checks, lint and audits, type checks, unit and integration suites, desktop smoke tests, and browser E2E checks. No heavy local checks were run for the final pass.
  • Both reviewers completed three rounds; Greptile reports 5/5 and all nine review threads are resolved.
  • Browser QA used current-source previews; the hosted deployment preview requires two-factor sign-in. External provider setup was checked against source and primary documentation, not by signing into every provider account.

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated (no new tests; existing CI suites passed)
  • 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 21, 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 21, 2026 3:53am UTC

Request Review

@greptile-apps

greptile-apps Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The follow-up changes appear safe to merge; no new actionable issues were found.

Summary

This PR updates documentation screenshots, shortens copy, simplifies the footer, and refines API examples and integration references.

  • Updated screenshots and a compact footer give the docs a clearer reading experience.
  • Long integration field tables open only when readers need their details.
  • API reference examples and controls are easier to switch between and scan.
  • Getting started now links to a separate research-agent walkthrough.
  • Integration and tool descriptions say more plainly what each operation offers.

Reviews (3) · Last reviewed commit: "fix(docs): keep OAuth setup prerequisite..." · Reviewed by Greptile

Comment thread apps/docs/components/ui/block-info-card.tsx 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.

All reported issues were addressed across 364 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/docs/components/footer/footer.tsx
Comment thread apps/docs/components/ui/block-info-card.tsx Outdated
Comment thread apps/sim/blocks/blocks/notion.ts Outdated
Comment thread apps/docs/components/docs-layout/sidebar-components.tsx Outdated
Comment thread apps/sim/tools/posthog/get_project.ts Outdated
Comment thread apps/docs/components/introduction.tsx
Comment thread apps/docs/components/introduction.tsx
@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 21, 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 365 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 scripts/generate-docs.ts Outdated
@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 21, 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 361 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
waleedlatif1 merged commit fd4323a into staging Oct 21, 2026
47 of 48 checks passed
@waleedlatif1
waleedlatif1 deleted the codex/docs-polish branch October 21, 2026 03:52

This branch was successfully deployed

1 active deployment
Preview — a4259849 Deployed Oct 21, 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