Skip to content

docs: rewrite readme#374

Merged
Teingi merged 7 commits intooceanbase:mainfrom
PsiACE:polish-readme
Apr 7, 2026
Merged

docs: rewrite readme#374
Teingi merged 7 commits intooceanbase:mainfrom
PsiACE:polish-readme

Conversation

@PsiACE
Copy link
Copy Markdown
Member

@PsiACE PsiACE commented Mar 26, 2026

Summary

Just rewritten to make it clearer

Solution Description


Note

Low Risk
Documentation-only changes (no code or config behavior changes), with minimal risk beyond potential link/text inaccuracies.

Overview
Rewrites README.md, README_CN.md, and README_JP.md to streamline the project overview and make onboarding clearer.

Reorganizes the docs into a more structured flow: OpenClaw plugin install snippet, a consolidated quick start (including .env/pmem config init guidance), clearer CLI/HTTP server/MCP entry points (including an entry-point table and an optional MCP <details> block), and a simplified benchmark section with a small results table.

Refreshes navigation by replacing the long feature/release-note sections with curated Docs, Examples, and a compact Release highlights table, plus standardizes badges and support/license sections.

Reviewed by Cursor Bugbot for commit 3c7b350. Bugbot is set up for automated code reviews on this repo. Configure here.

PsiACE added 7 commits March 25, 2026 18:13
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Copy link
Copy Markdown
Member

@Teingi Teingi left a comment

Choose a reason for hiding this comment

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

LGTM

@Teingi Teingi merged commit 349ab66 into oceanbase:main Apr 7, 2026
11 checks passed
@PsiACE PsiACE deleted the polish-readme branch April 7, 2026 08:03
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