jeffusion 4d0ad6bf20 docs: restructure documentation with progressive disclosure
- README.md: trim to product overview + minimal quick start +
  single navigation table; remove duplicated Quick start section
- docs/README.md / zh-CN.md: rewrite as grouped navigation index
  with descriptions (Getting started / Reference / Deployment)
- docs/getting-started.md / zh-CN.md: add screenshot preview,
  improve structure with numbered configuration steps, add
  "Next steps" cross-links
- docs/configuration.md / zh-CN.md: fix heading hierarchy (###
  instead of ## 1)), convert Admin UI settings to tables, move
  Agent Definitions and Tool Permissions to review-engines.md
- docs/review-engines.md / zh-CN.md: add Agent Definitions and
  Tool Permissions sections (migrated from configuration.md),
  add model resolution order, convert to tables for clarity
- CONTRIBUTING.md: add development setup, code quality commands,
  PR workflow, and Conventional Commits convention
2026-05-27 10:37:28 +08:00
2026-05-26 23:35:58 +00:00

Gitea AI Assistant

License: MIT

AI-powered code review assistant for Gitea. Receives webhooks, runs AI review workflows, and posts summary + line-level feedback back to Gitea.

English | 中文

Features

  • Automated PR & commit review via webhook events
  • Dynamic Agent engine — main agent autonomously spawns subagents for focused analysis
  • Codex engine — Codex CLI-backed review as an alternative pipeline
  • Pluggable LLM providers — OpenAI Compatible, OpenAI Responses API, Anthropic, Gemini
  • Web Admin UI — runtime configuration for providers, models, webhook, review policy
  • Notifications — Feishu + WeCom (企业微信)
  • Security-first — webhook signature verification + AES-256-GCM encrypted API key storage

Dashboard

Quick start

git clone https://github.com/jeffusion/gitea-ai-assistant.git
cd gitea-ai-assistant
bun install                       # installs frontend via postinstall

Create .env:

ENCRYPTION_KEY=$(openssl rand -hex 32)
bun run dev

Open http://localhost:5174, login with default password password (change it immediately), then configure Gitea, LLM providers, and webhook in the Admin UI.

See Getting Started for full setup walkthrough including webhook configuration.

Documentation

Topic Description
Getting Started Full installation and setup walkthrough
Configuration Environment variables and Admin UI settings
Review Engines Agent engine, Codex engine, review modes
Deployment Docker, Compose, and Kubernetes
Screenshots Admin UI gallery

Contributing

See CONTRIBUTING.md for development conventions and UI guidelines.

License

MIT

Description
Gitea功能增强助手,基于Bun和TypeScript开发,提供AI驱动的代码审查等增强功能。本工具通过Webhook与Gitea集成,自动对Pull Request和提交进行代码审查,并提供智能化的代码质量分析。
Readme 7.8 MiB
Languages
TypeScript 96.5%
Shell 1.5%
CSS 1.5%
JavaScript 0.3%
Dockerfile 0.2%