Skip to content

📖 docs: Complete Quick Start Install Steps and Cover macOS - #839

Merged
berry-13 merged 6 commits into
mainfrom
berry-13/auto-librechat-ai-address-feedbacks-run-49-20261018T1800
Oct 18, 2026
Merged

berry-13 merged 6 commits into
mainfrom
berry-13/auto-librechat-ai-address-feedbacks-run-49-20261018T1800

Conversation

@berry-13

@berry-13 berry-13 commented Oct 18, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

The Quick Start hub cards stopped at "start the app", so readers never learned to open localhost:3080 and register. The npm card also listed Node.js v20.19+, but LibreChat now pins 24.16.0 (.nvmrc, matching the npm guide). Step 3 of the condensed Local Setup guide said "navigate to the project directory" and "fill in any necessary values" without giving the commands. Separately, the "desktop installer" callout on the docs index covered Windows and Linux but not macOS.

Hub card strings are hand-maintained, so all 14 locale dictionaries are updated. The MDX edits are English only and go through the usual translation workflow. Since main gained the Step 4 "Start Chatting" handoff to Your First Chat, this PR keeps that step and only makes Step 3 concrete.

Feedback addressed

  • 1561174654356562005: /pt-BR/docs/quick_start
    • The quick guide does not give the full installation steps.
    • Added an "open localhost:3080 and register" step to the Docker and npm cards in every locale, and fixed the npm Node.js prereq to v24.16.0. Local Setup Step 3 now gives the exact cd, .env copy (including the Windows copy form) and docker compose up -d commands, what to expect on first launch, and a link to Docker troubleshooting. Checked PORT=3080 and ALLOW_REGISTRATION=true against upstream .env.example.
    • Classification: FIXED
  • 1561325513748779132: /es/docs
    • "What about mac?": the desktop installer callout names Windows and Linux only.
    • Added macOS guidance that points to Docker Desktop and to the existing Apple Silicon MongoDB note in the Docker guide prerequisites.
    • Classification: FIXED

Validation

  • New e2e/quick-start-install-steps.spec.ts, four scenarios: card steps in English, card steps in all 13 other locales, Local Setup command order plus the troubleshooting and First Chat links, and macOS in the docs callout. All four pass in the End-to-end tests job on this head (full suite 62 passed).
  • npx eslint --max-warnings 0 and prettier --check on the changed TS files: passed
  • pnpm typecheck: passed
  • npx vitest run: 38 files, 436 tests passed

Not changed

  • The Apple Silicon callout in local/docker.mdx is unchanged. It is outside what either report asked about.

@vercel

vercel Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
librechat-ai Ready Ready Preview Oct 18, 2026 7:20pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 18, 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-18T19:16:42.177587Z f75f363 New commits
🔒 Security Review ✅ Completed 2026-10-18T18:07:21.413787Z 690877c 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.

Quick Start hub cards now end with opening localhost:3080 and registering, and the npm card lists the Node.js version LibreChat pins (24.16.0) instead of the stale v20.19+. The condensed Local Setup guide now gives the exact cd, .env copy, and first-run commands plus the first-account-is-admin note.

Feedback: 1561174654356562005
@berry-13
berry-13 force-pushed the berry-13/auto-librechat-ai-address-feedbacks-run-49-20261018T1800 branch from 690877c to f9f4a9c Compare October 18, 2026 18:53

@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: f9f4a9c06f

ℹ️ 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".


// The failure path points somewhere that exists.
const troubleshooting = body(page).getByRole('link', {
name: 'Docker guide troubleshooting section',

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Check the handoff before leaving the setup page

Move the Your First Chat assertion before this click (or navigate back afterward). The click navigates from Local Setup to the Docker troubleshooting section, and the Docker guide independently contains a Your First Chat link, so the test still passes if the newly documented Step 4 handoff is later removed or given an incorrect URL.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed in 1300210: the handoff assertion now runs on Local Setup before the click into the Docker guide. f75f363 also matches the link exactly, because the footer's next-page card links to Your First Chat too and would have masked a missing Step 4 link. @Scenario:local-setup-gives-exact-run-commands passes in the End-to-end tests job on f75f363 (62/62).

@github-actions

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@github-actions

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@github-actions

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@berry-13
berry-13 merged commit a203120 into main Oct 18, 2026
5 checks passed
@berry-13
berry-13 deleted the berry-13/auto-librechat-ai-address-feedbacks-run-49-20261018T1800 branch October 18, 2026 20:23

This branch was successfully deployed

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