docs: Clarify LiveQuery options in --help output

[dblythy]

Closes #6910

Two of the three LiveQuery options in --help both claim to start the LiveQuery server, which is misleading:

--liveQueryServerOptions   Live query server configuration options (will start the liveQuery server)
--startLiveQueryServer     Starts the liveQuery server

The trap (per the issue): you can start the server and get connections/subscriptions, but no create/update/delete events arrive - because events are only published for the classes set in liveQuery.classNames, which isn't obvious from the help text.

This rewords all three (liveQuery, startLiveQueryServer, liveQueryServerOptions) to spell out that liveQuery.classNames is what makes events flow, and that a minimal working setup is liveQuery: { classNames: [...] } plus startLiveQueryServer. Docs-only - regenerated Definitions.js and docs.js from index.js.

Summary by CodeRabbit

• Documentation
  • Clarified how LiveQuery classNames controls which create/update/delete events are delivered.
  • Documented that LiveQuery server options trigger starting the LiveQuery server.
  • Expanded guidance for running LiveQuery alongside Parse Server and reinforced the event-delivery limitation to the configured classes.

[parse-github-assistant]

🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review.

Tip

• Keep pull requests small. Large PRs will be rejected. Break complex features into smaller, incremental PRs.
• Use Test Driven Development. Write failing tests before implementing functionality. Ensure tests pass.
• Group code into logical blocks. Add a short comment before each block to explain its purpose.
• We offer conceptual guidance. Coding is up to you. PRs must be merge-ready for human review.
• Our review focuses on concept, not quality. PRs with code issues will be rejected. Use an AI agent.
• Human review time is precious. Avoid review ping-pong. Inspect and test your AI-generated code.

Note

Please respond to review comments from AI agents just like you would to comments from a human reviewer. Let the reviewer resolve their own comments, unless they have reviewed and accepted your commit, or agreed with your explanation for why the feedback was incorrect.

Caution

Pull requests must be written using an AI agent with human supervision. Pull requests written entirely by a human will likely be rejected, because of lower code quality, higher review effort and the higher risk of introducing bugs. Please note that AI review comments on this pull request alone do not satisfy this requirement. Our CI and AI review are safeguards, not development tools. If many issues are flagged, rethink your development approach. Invest more effort in planning and design rather than using review cycles to fix low-quality code.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2977ced2-3aaf-45ea-9123-33ee16ea5ede

📥 Commits

Reviewing files that changed from the base of the PR and between 678a7db and 16fe988.

📒 Files selected for processing (1)

• src/Options/Definitions.js

🚧 Files skipped from review as they are similar to previous changes (1)

• src/Options/Definitions.js

---

📝 Walkthrough

Walkthrough

LiveQuery option documentation now explains class-based event publishing, LiveQuery server startup, and the relationship between liveQuery, liveQueryServerOptions, and startLiveQueryServer.

Changes

LiveQuery documentation

Layer / File(s)	Summary
Clarify LiveQuery configuration descriptions src/Options/Definitions.js, src/Options/docs.js, src/Options/index.js	Descriptions now state that liveQuery.classNames controls published events, while supplying liveQueryServerOptions or enabling startLiveQueryServer starts the LiveQuery server without replacing the class configuration.

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

Suggested reviewers: moumouls

---

Caution

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

• Ignore

❌ Failed checks (1 error, 1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❌ Error	The title is relevant, but it uses the unsupported "docs:" prefix instead of the required "doc:" prefix.	Rename the title to start with "doc:" and keep it aligned with the LiveQuery help text clarification.
Engage In Review Feedback	❓ Inconclusive	Repo shows the docs fix, but no review-thread/comment history exists locally to prove prior engagement before resolution.	Provide the PR review discussion or comment history showing the feedback was discussed before being resolved, or a commit/reply referencing that exchange.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description covers the issue and approach, but it does not follow the full template or include the task checklist.
Linked Issues check	✅ Passed	The changes match #6910 by clarifying LiveQuery setup, event publishing requirements, and the role of liveQueryServerOptions.
Out of Scope Changes check	✅ Passed	The PR appears documentation-only and stays within the LiveQuery help text scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Security Check	✅ Passed	No new vuln patterns found; the touched code is defensive (null-proto context copies, GraphQL error redaction, session guard) and adds no eval/shell/unsafe merge.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.69%. Comparing base (b9912b0) to head (16fe988).
⚠️ Report is 1 commits behind head on alpha.

Additional details and impacted files

@@           Coverage Diff           @@
##            alpha   #10558   +/-   ##
=======================================
  Coverage   92.69%   92.69%           
=======================================
  Files         193      193           
  Lines       17027    17027           
  Branches      248      248           
=======================================
  Hits        15784    15784           
  Misses       1222     1222           
  Partials       21       21           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[mtrezza]

@dblythy Please let CR review first before requesting a human review, thanks.

[dblythy]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[dblythy]

@coderabbitai can you approve?

[coderabbitai]

@dblythy Approved. The documentation-only clarification aligns with the stated LiveQuery configuration requirements.

✅ Action performed

Comments resolved and changes approved.

[parseplatformorg]

🎉 This change has been released in version 9.10.1-alpha.4