Skip to content

docs: revamp README with branding, community assets, and project policies#248

Merged
mrcfps merged 4 commits intomainfrom
docs/update-readme-and-community-assets
Mar 18, 2026
Merged

docs: revamp README with branding, community assets, and project policies#248
mrcfps merged 4 commits intomainfrom
docs/update-readme-and-community-assets

Conversation

@qiongyu1999
Copy link
Copy Markdown
Collaborator

@qiongyu1999 qiongyu1999 commented Mar 18, 2026

Summary

  • Rewrite README.md (EN) and add README.zh-CN.md (CN) with full product positioning, features, use cases, and updated project structure reflecting the actual monorepo layout
  • Add branding assets to site/media/: logo SVG, Discord QR code, Feishu QR code
  • Update all GitHub links from openclaw/openclaw to nexu-io/nexu, official site from lio.ai to nexu.io
  • Add Star History chart with GitHub dark/light theme support
  • Add LICENSE (MIT, Powerformer Inc.) and CODE_OF_CONDUCT.md (Contributor Covenant v2.0)
  • Update dev commands from npm to pnpm to match actual toolchain (pnpm@10.26.0)

Changed files

File Change
README.md Full rewrite with EN product copy
README.zh-CN.md New — Chinese translation
LICENSE New — MIT license
CODE_OF_CONDUCT.md New — Contributor Covenant v2.0
site/media/nexu-logo.svg New — Logo
site/media/discord-qr.png New — Discord community QR
site/media/feishu-qr.png New — Feishu community QR

Test plan

  • Verify README renders correctly on GitHub (EN & CN)
  • Verify logo, QR codes, badges, and Star History chart display properly
  • Verify all links (nexu.io, GitHub releases, discussions, issues) resolve correctly
  • Confirm LICENSE and CODE_OF_CONDUCT tabs appear on repo page

Made with Cursor

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Mar 18, 2026

Deploying nexu-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9faa068
Status: ✅  Deploy successful!
Preview URL: https://4792fe6b.nexu-docs.pages.dev
Branch Preview URL: https://docs-update-readme-and-commu.nexu-docs.pages.dev

View logs

…cies

- Rewrite README.md (EN) and add README.zh-CN.md (CN) with full product
  positioning, features, use cases, and updated project structure
- Add logo (SVG), Discord QR code, and Feishu QR code to site/media/
- Update all GitHub links to nexu-io/nexu, official site to nexu.io
- Add Star History chart with dark/light theme support
- Add LICENSE (MIT) and CODE_OF_CONDUCT.md (Contributor Covenant v2.0)
- Update dev commands from npm to pnpm to match actual toolchain

Made-with: Cursor
- Switch release and license badges to static shields (works for private repos)
- Rename all "Nexu" to "nexu" for consistent lowercase branding
- Fix `cd openclaw` to `cd nexu` in quick start instructions

Made-with: Cursor
@qiongyu1999 qiongyu1999 force-pushed the docs/update-readme-and-community-assets branch from 61efd5d to ad3fbae Compare March 18, 2026 09:07
Copy link
Copy Markdown
Contributor

@shangxinyu1 shangxinyu1 left a comment

Choose a reason for hiding this comment

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

pass

@mrcfps mrcfps merged commit 63ffe4a into main Mar 18, 2026
6 checks passed
@mrcfps mrcfps deleted the docs/update-readme-and-community-assets branch March 18, 2026 09:33
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.

5 participants