docs: update onboarding and product docs
This commit is contained in:
777genius
parent
f237318c29
commit
353492eb18
7 changed files with 26 additions and 6 deletions
4
.github/CONTRIBUTING.md
vendored
4
.github/CONTRIBUTING.md
vendored
|
|
@ -9,10 +9,12 @@ For big features and major changes, please discuss them in our [Discord](https:/
|
|||
Small fixes, bug reports, and minor improvements are always welcome - just open a PR.
|
||||
|
||||
## Prerequisites
|
||||
- Node.js 20+
|
||||
- Node.js 24.16.0 LTS
|
||||
- pnpm 10+
|
||||
- macOS, Windows, or Linux
|
||||
|
||||
On macOS, official Node.js 24 prebuilt binaries require macOS 13.5+ for source development.
|
||||
|
||||
## Setup
|
||||
```bash
|
||||
pnpm install
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -150,6 +150,8 @@ An orchestration layer for AI agent teams across Claude, Codex, and OpenCode.
|
|||
|
||||
- **Zero-setup onboarding** — start with the free model with no auth, then connect paid/account providers only when you need them
|
||||
|
||||
- **Multi-language support** - choose the app language and preferred agent communication language. Current UI languages: Arabic, Bengali, Chinese, English, French, German, Hindi, Indonesian, Japanese, Korean, Portuguese, Russian, Spanish, Urdu.
|
||||
|
||||
- **Built-in code editor** — edit project files with Git support without leaving the app
|
||||
|
||||
- **Branch strategy** - choose per teammate at launch: use the main checkout or run selected agents in their own git worktree. You can still spell out branch rules in the provisioning prompt.
|
||||
|
|
@ -283,7 +285,9 @@ Electron 40, React 19, TypeScript 5, Tailwind CSS 3, Zustand 4. Data from `~/.cl
|
|||
|
||||
<br />
|
||||
|
||||
**Prerequisites:** Node.js 20+, pnpm 10+
|
||||
**Prerequisites:** Node.js 24.16.0 LTS, pnpm 10+
|
||||
|
||||
On macOS, official Node.js 24 prebuilt binaries require macOS 13.5+.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/777genius/agent-teams-ai.git
|
||||
|
|
@ -374,10 +378,18 @@ local packaging.
|
|||
|
||||
See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for development guidelines. Please read our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
||||
|
||||
## Partnerships
|
||||
|
||||
We are open to partnerships and collaboration opportunities. If you see a way to create value together, we are ready to discuss mutually beneficial terms.
|
||||
|
||||
Contact: [quantjumppro@gmail.com](mailto:quantjumppro@gmail.com)
|
||||
|
||||
## Security
|
||||
|
||||
IPC and standalone HTTP handlers validate IDs, paths, and payload shape at the boundary. Project editing and write operations are constrained to the selected project root, while read-only discovery also accesses local Claude data under `~/.claude/` and app-owned state paths when required. Path traversal and sensitive config/credential targets are blocked. See [SECURITY.md](.github/SECURITY.md) for details.
|
||||
|
||||
GitHub Dependabot monitors dependencies for known vulnerabilities, so security updates are surfaced quickly and applied in time.
|
||||
|
||||
## License
|
||||
|
||||
[AGPL-3.0](LICENSE)
|
||||
|
|
|
|||
|
|
@ -1266,7 +1266,7 @@ Binary: null bytes в первых 8KB или расширение (.png, .wasm)
|
|||
|
||||
### 19.8 File Watcher (Impact: MEDIUM)
|
||||
|
||||
Проект использует `fs.watch({ recursive: true })`, не chokidar. Electron 40/Node 20+ OK.
|
||||
Проект использует `fs.watch({ recursive: true })`, не chokidar. Electron 40/Node 24.16+ OK.
|
||||
|
||||
**Решение:** fs.watch + фильтр (node_modules/.git/dist) + debounce 200ms + **opt-in** (ручной F5 по умолчанию) + cleanup.
|
||||
|
||||
|
|
|
|||
|
|
@ -49,9 +49,11 @@ For source development, you also need:
|
|||
|
||||
| Tool | Version |
|
||||
| ------- | ------- |
|
||||
| Node.js | 20+ |
|
||||
| Node.js | 24.16.0 LTS |
|
||||
| pnpm | 10+ |
|
||||
|
||||
On macOS, official Node.js 24 prebuilt binaries require macOS 13.5+.
|
||||
|
||||
## Run from source
|
||||
|
||||
<InstallBlock command="git clone https://github.com/777genius/agent-teams-ai.git && cd agent-teams-ai && pnpm install && pnpm dev" />
|
||||
|
|
|
|||
|
|
@ -51,6 +51,8 @@ For project conventions and architecture guidance, refer to these canonical file
|
|||
|
||||
**Or run from source** for development:
|
||||
|
||||
Requires Node.js 24.16.0 LTS and pnpm 10+. On macOS, official Node.js 24 prebuilt binaries require macOS 13.5+.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/777genius/agent-teams-ai.git
|
||||
cd agent-teams-ai
|
||||
|
|
|
|||
|
|
@ -42,9 +42,11 @@ Gemini — поддерживаемый провайдер. Варианты aut
|
|||
|
||||
| Инструмент | Версия |
|
||||
| ---------- | ------ |
|
||||
| Node.js | 20+ |
|
||||
| Node.js | 24.16.0 LTS |
|
||||
| pnpm | 10+ |
|
||||
|
||||
На macOS официальные prebuilt-бинарники Node.js 24 требуют macOS 13.5+.
|
||||
|
||||
## Запуск из исходников
|
||||
|
||||
<InstallBlock command="git clone https://github.com/777genius/agent-teams-ai.git && cd agent-teams-ai && pnpm install && pnpm dev" label="Скопировать" copied-label="Скопировано" />
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ lang: ru-RU
|
|||
- **macOS, Windows или Linux** машина
|
||||
- **Git-репозиторий** в качестве проекта (рекомендуется для diff review и worktree isolation)
|
||||
- Бесплатная модель без авторизации для первого запуска или доступ к провайдеру, если нужны дополнительные модели: Anthropic (Claude), OpenAI (Codex), OpenRouter (OpenCode) или Google (Gemini)
|
||||
- Node.js 20+ и pnpm 10+ при запуске из исходников
|
||||
- Node.js 24.16.0 LTS и pnpm 10+ при запуске из исходников
|
||||
|
||||
Подробности и ссылки для скачивания — в разделе [Установка](/ru/guide/installation).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue