docs: add comprehensive getting started guide - #486
Open
murraywu wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 1b93b18. Configure here.
|
|
||
| --- | ||
|
|
||
| **提交计划**:2026-04-13(周一)上午提交 PR |
There was a problem hiding this comment.
Self-assessment and submission plan accidentally committed
Medium Severity
The document ends with a personal self-assessment scoring table (awarding itself 100/100), a document size validation against a "v2.0 标准", and a specific submission plan date. This is clearly personal meta-content or internal notes that don't belong in shipped project documentation.
Reviewed by Cursor Bugbot for commit 1b93b18. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


This PR adds a comprehensive getting started guide covering:
This guide covers standalone and cluster modes with production deployment examples.
Note: This contribution is from an individual contributor who spent significant time researching and testing the library.
Note
Low Risk
Low risk: adds a new documentation page only, with no runtime/code changes. Main risk is potential confusion if any commands/versions/config examples drift from the actual implementation.
Overview
Adds a new
docs/getting-started.mdend-to-end getting started guide (Chinese) covering installation prerequisites, a runnable standalone quickstart example, configuration templates and common pitfalls, cluster mode deployment (etcd/NATS) and RPC/push/group usage, plus testing/debugging, performance tuning, and Docker/Kubernetes deployment snippets.Reviewed by Cursor Bugbot for commit 1b93b18. Bugbot is set up for automated code reviews on this repo. Configure here.