Skip to content

docs: elevate bilingual project README - #6

Merged
computersciencefreshmen merged 1 commit into
mainfrom
agent/readme-world-class
Jul 24, 2026
Merged

docs: elevate bilingual project README#6
computersciencefreshmen merged 1 commit into
mainfrom
agent/readme-world-class

Conversation

@computersciencefreshmen

Copy link
Copy Markdown
Owner

What changed

  • Rebuilt the Chinese and English README files around a product hero, navigation, quality signals, explicit learning journeys, a reproducible local start, architecture, security evidence, scope, and governance.
  • Restored the original brand logo and portfolio-style visual hierarchy while replacing stale SQLite and same-process claims with the current PostgreSQL, R2/MinIO, Vercel/Railway, and HMAC mail-relay design.
  • Made historical ADR status explicit, corrected the API rewrite path, and updated the security policy to match PostgreSQL and private object storage.
  • Reframed the Vercel/Railway topology as a reference deployment because the configured public Vercel URL is currently unreachable.

Why

The previous cloud-migration README was technically useful but read like a short operations handoff. This change makes the repository understandable in three stages: value in seconds, a runnable workflow in minutes, and architecture/security evidence for deeper evaluation.

Validation

  • pnpm check — 71/71 Node tests, ESLint, Prettier, and production build
  • Final pnpm format:check
  • git diff --check
  • Independent reader and fact audits against runtime configuration, CI, and operations documentation

Operator note

This PR does not claim a live public website. Before exposing a production demo, restore or bind the Vercel domain, configure secrets, and validate the SPA, /api/v1/* rewrite, mail relay, and readiness endpoint using the operations manual.

@vercel

vercel Bot commented Jul 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
international-chinese-platform Ready Ready Preview, Comment Jul 24, 2026 6:06am

@computersciencefreshmen
computersciencefreshmen merged commit 089c67e into main Jul 24, 2026
4 checks passed
@computersciencefreshmen
computersciencefreshmen deleted the agent/readme-world-class branch July 24, 2026 06:09
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.

1 participant