Commit Graph

6 Commits

Author SHA1 Message Date
lanceyq
9c72631518 [changes] Update README.md and README_CN.md 2026-05-06 10:31:33 +08:00
lanceyq
89ae61bfc1 docs(readme): update image paths from docs/ to assets/
Migrate all image src references in README.md and README_CN.md from
./docs/generated/ and ./docs/screenshots/ to ./assets/generated/ and
./assets/screenshots/ to match the actual directory structure.

Also replace an external GitHub user-attachments URL with a local
./assets/screenshots/frontend-ui.png path in README.md.
2026-05-06 10:31:33 +08:00
lanceyq
124aa9fef8 docs: overhaul README and add project documentation assets
- 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
2026-05-06 10:31:33 +08:00
Ke Sun
9f2cd6afae docs: add status badges to README files
- Add Apache 2.0 license badge to both README.md and README_CN.md
- Add Python 3.12+ version badge with logo
- Add Gitee Sync workflow status badge linking to GitHub Actions
- Improve project visibility with standardized badge indicators
2026-04-02 11:57:23 +08:00
Ke Sun
47bf93d65e docs(config): update Celery environment variable naming convention
- Replace BROKER_URL and RESULT_BACKEND with REDIS_DB_CELERY_BROKER and REDIS_DB_CELERY_BACKEND in README.md
- Replace BROKER_URL and RESULT_BACKEND with REDIS_DB_CELERY_BROKER and REDIS_DB_CELERY_BACKEND in README_CN.md
- Update api/env.example with new variable names and add deprecation notice
- Add reference to celery-env-bug-report.md documentation explaining why old variable names are avoided
- Prevents environment variable hijacking by Celery CLI when using standard naming conventions
2026-03-06 10:28:03 +08:00
lanceyq
083c460687 [updated]Updating the Chinese and English versions of the readme. 2025-12-16 14:33:31 +08:00