Skip to content

Document Cloud Agent preview details - #3745

Open
gillian-meilisearch wants to merge 1 commit into
mainfrom
cursor/cloud-agent-preview-notes-eb8a
Open

gillian-meilisearch wants to merge 1 commit into
mainfrom
cursor/cloud-agent-preview-notes-eb8a

Conversation

@gillian-meilisearch

@gillian-meilisearch gillian-meilisearch commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adds a short Cloud Agent section to AGENTS.md. It records details that are easy to miss when previewing this Mintlify site:

  • Mintlify needs Node.js 20.17 or newer and refuses Node.js 25. Node.js 22 on the default image is enough (.nvmrc lists 23, CI uses 20).
  • Dependencies install with npm ci. The preview client lives in ~/.mintlify and comes from releases.mintlify.com when it is missing.
  • The local site starts with npx mint dev --no-open on http://localhost:3000.
  • Reading pages does not need a Mintlify account. Search in the preview needs mint login.

This pull request was written with Cursor Cloud Agent while setting up the repository environment. The agent used it to record commands that were run locally (npm ci and npx mint dev --no-open).

Checklist

For internal Meilisearch team member only:

For external maintainers

  • Did you use any AI tool while implementing this PR (code, tests, docs, etc.)? If yes, disclose it in the PR description and describe what it was used for. AI usage is allowed when it is disclosed.
  • Have you made sure that the title is accurate and descriptive of the changes?
Open in Web Open in Cursor 

Summary by CodeRabbit

  • Documentation
    • Added guidance on the documentation site’s Node.js requirements, installing dependencies, starting a local preview, and accessing its URL.
    • Clarified that preview search requires a Mintlify account.

Record the Node.js version Mintlify accepts, where the preview client is stored, and how to start the local site without a Mintlify login.

Co-authored-by: gillian-meilisearch <gillian-meilisearch@users.noreply.github.com>
@mintlify

mintlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
meilisearch-documentation 🟢 Ready View Preview Oct 28, 2026, 11:23 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 6f9945e6-6109-4a4e-9022-f6f85137d277
Commits

Reviewing files that changed from the base of the PR and between a2d5904 and 357fcf0.

Files selected for processing: 1
  • AGENTS.md

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

Walkthrough

AGENTS.md adds Cloud Agent instructions for setting up and accessing the documentation site preview.

Changes: Cloud Agent setup

Layer / File(s) Summary
Document preview setup
AGENTS.md
Adds Node.js version guidance, dependency installation and preview commands, preview URL behavior, and Mintlify account requirements for search.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

Suggested reviewers: qdequele

Merge Risk: Minimal · up to 357fc

The documentation matches the pinned CLI behavior, and no confirmed merge-blocking issue remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Document Cloud Agent preview details" matches the main change. The PR adds a Cloud Agent section to AGENTS.md that documents the local Mintlify preview setup, including Node.js version cons…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "Document Cloud Agent preview details" matches the main change. The PR adds a Cloud Agent section to AGENTS.md that documents the local Mintlify preview setup, including Node.js version constraints, dependency installation with npm ci, the preview client location, the startup command, and the account requirement for preview search. The title is specific and concise, and it describes the documentation change accurately.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

This branch was successfully deployed

1 active deployment
staging — 357fcf01 Deployed Oct 28, 2026 by mintlify[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.

2 participants