Skip to content

docs: refresh setup and testing guidance and repair references - #588

Merged
sojan-official merged 3 commits into
mainfrom
fix/current-setup-and-reference-docs
Oct 20, 2026
Merged

sojan-official merged 3 commits into
mainfrom
fix/current-setup-and-reference-docs

Conversation

@sojan-official

@sojan-official sojan-official commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

Current setup instructions can select Ruby/Node/pnpm versions that do not satisfy Chatwoot's runtime pins, and the first-run Docker sequence tries to enter an unstarted container. Align the requirements, platform setup and troubleshooting guidance with Ruby 3.4.4, Node 24 and pnpm 10, while directing older checkouts to their own version files. Install pnpm in a user-owned npm prefix and persist shell PATH entries; resolve the Homebrew prefix for both Apple Silicon and Intel Macs.

Replace the obsolete Cypress instructions with the existing Playwright E2E workflow and redirect the old testing URL. Correct the S3 and MaxMind references and the PostgreSQL troubleshooting fragment. The local-development guide receives the same runtime and E2E corrections so it does not contradict the platform guides. The contribution overview links directly to Playwright and runs its package script from the correct directory.

Validation:

  • Mintlify broken-link check passes.
  • Review-touched guides: 152 shell snippets pass syntax checks in both Bash and Zsh. A non-root temporary pnpm installation and fresh-shell PATH checks pass; npm configuration remains unchanged.
  • Initial 12-page browser validation covers the changed routes, troubleshooting fragment and Cypress redirect, with desktop/mobile review of the new guide. All five review-updated setup/troubleshooting pages were rechecked, including the three platform tabs.
  • Locked Playwright dependencies install in an isolated copy; playwright test --list discovers 5 tests across 3 files without running them.
  • The final overview link is verified in the local browser, its shell snippet parses in Bash and Zsh, and its exact Playwright package command discovers the same 5 tests without running them.
  • Replacement S3 and MaxMind pages return 200; the S3 section anchor exists.

Full OS installations and application E2E scenarios were not run. This PR changes documentation only and does not include the separately prepared Ahrefs heading/metadata fixes.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-20T10:08:05.740823Z 75ef76e New commits
🔒 Security Review ✅ Completed 2026-10-20T09:34:42.068807Z 9df1ff7 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9df1ff790e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@sojan-official
sojan-official merged commit 5628af9 into main Oct 20, 2026
2 checks passed
@sojan-official
sojan-official deleted the fix/current-setup-and-reference-docs branch October 20, 2026 10:17
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