docs: overhaul README and add project documentation assets

Browse Source

- Rewrite README.md and README_CN.md with comprehensive project documentation
  including core features, architecture overview, benchmarks, tech stack,
  quick start guide, and detailed installation instructions
- Add CONTRIBUTING.md with contribution guidelines
- Add architecture.svg and directory-structure.svg diagrams
- Add generated PNG assets for hero banner, core features, pain points,
  architecture, and benchmark results
- Add screenshot PNGs for installation guide (PostgreSQL, Neo4j, Alembic,
  API docs, frontend UI)
- Replace external GitHub image URLs with local asset references

...

This commit is contained in:

lanceyq

2026-04-29 14:11:58 +08:00

parent 3743188eec

commit 124aa9fef8

22 changed files with 1118 additions and 403 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

BIN

assets/screenshots/alembic-migration.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 59 KiB

BIN

assets/screenshots/api-docs.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 93 KiB

BIN

assets/screenshots/db-tables.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 167 KiB

BIN

assets/screenshots/frontend-start.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 29 KiB

BIN

assets/screenshots/frontend-ui.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 280 KiB

BIN

assets/screenshots/neo4j-container.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 201 KiB

BIN

assets/screenshots/neo4j-running.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 298 KiB

BIN

assets/screenshots/pg-container.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 226 KiB

BIN

assets/screenshots/pg-pull.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 335 KiB

BIN

assets/screenshots/pg-running.png Normal file

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 354 KiB