Commit Graph

4 Commits

Author SHA1 Message Date
lintsinghua e856ad1a8d chore: rebrand XCodeReviewer to DeepAudit across all files
- Update project name from XCodeReviewer to DeepAudit in CI/CD workflows
- Replace Docker image names and release artifact naming conventions
- Update GitHub repository references in documentation files
- Modify database names and container names in setup instructions
- Update contributor badge and issue tracker links
- Rename frontend logo file from logo_deepaudit.png
- Update environment configuration examples and documentation
- Rebrand all references in CONTRIBUTING.md, DISCLAIMER.md, and README.md
- Update backend configuration and deployment documentation
- Ensure consistent naming across frontend and backend configurations
2025-12-08 21:35:09 +08:00
lintsinghua f982d6a5e6 feat: 添加演示账户和演示数据,完善项目文档
- 添加演示账户 demo@example.com / demo123
- 创建 6 个演示项目和 15 个审计任务
- 完善 DEPLOYMENT.md、CONFIGURATION.md、LLM_PROVIDERS.md、FAQ.md 文档
- 更新 CONTRIBUTING.md、SECURITY.md、DISCLAIMER.md
- 前端版本号自动从 package.json 读取
- 仪表盘项目概览显示 6 个项目
- 版本号更新为 2.0.0-beta.3
2025-12-05 15:09:39 +08:00
lintsinghua 50d9d71f90 docs: expand contributing guidelines and improve documentation structure
- Restructure CONTRIBUTING.md with comprehensive sections including code of conduct, development setup, and PR workflow
- Add detailed environment requirements table with version specifications and descriptions
- Include step-by-step backend and frontend setup instructions with database initialization
- Document code standards for both Python (Ruff, mypy) and TypeScript (Biome) with example commands
- Add conventional commits specification with type definitions and practical examples
- Provide complete PR process guide from forking through code review
- Include project structure diagram for better navigation
- Expand DISCLAIMER.md with improved formatting, tables, and clearer responsibility sections
- Add AI analysis limitations and technical constraints documentation
- Update SECURITY.md with enhanced security guidelines
- Refresh backend/env.example and frontend/.env.example with current configuration options
- Create new docs/ARCHITECTURE.md for system design documentation
- Update docs/CONFIGURATION.md, docs/DEPLOYMENT.md, docs/FAQ.md, and docs/LLM_PROVIDERS.md with improved clarity and structure
- Improve overall documentation consistency and user experience across all guides
2025-12-05 14:37:07 +08:00
lintsinghua 8f113493e1 docs: add comprehensive documentation and guidelines
- Add CONTRIBUTING.md with development setup, code standards, and contribution workflow
- Add DISCLAIMER.md with privacy warnings, liability disclaimers, and user responsibilities
- Add SECURITY.md for code security and privacy guidelines
- Add docs/CONFIGURATION.md with backend configuration and database setup instructions
- Add docs/DEPLOYMENT.md with Docker and local development deployment guides
- Add docs/FAQ.md with frequently asked questions and troubleshooting
- Add docs/LLM_PROVIDERS.md with 10+ LLM platform configurations and API key setup
- Update README.md with documentation navigation table and streamlined feature descriptions
- Consolidate scattered documentation into organized docs/ directory for better maintainability
2025-12-05 13:38:14 +08:00