docs: keep only workflow testing and process guidance

This commit is contained in:
Jiayuan Zhang 2026-02-17 01:15:22 +08:00
parent 88582fe050
commit 2447230ca7
6 changed files with 49 additions and 1731 deletions

View file

@ -2,30 +2,18 @@
This file gives coding agents high-signal guidance for this repository.
## 1. Project Snapshot
## 1. Documentation Scope
Super Multica is a pnpm monorepo for a distributed AI agent system:
Documentation in this repo should prioritize:
- Agent engine + Hub: `packages/core`
- Desktop app (primary local runtime): `apps/desktop`
- CLI: `apps/cli`
- Remote access gateway: `apps/gateway`
- Web client: `apps/web`
1. Development workflow
2. Testing methods
3. Operational process
## 2. Monorepo Map
Project-intro and architecture explanations are intentionally minimized.
Treat source code as the architecture source of truth.
```text
apps/
cli desktop gateway server web mobile
packages/
core sdk ui store hooks types utils
skills/
skill assets and runtime helper scripts
```
## 3. Core Commands
## 2. Core Workflow Commands
```bash
pnpm install
@ -40,20 +28,13 @@ pnpm typecheck
pnpm test
```
## 4. Architecture Notes
- Desktop app embeds Hub + Agent runtime.
- Gateway is optional for local desktop usage, required for remote/web-style access.
- Web app depends on gateway/API setup.
- Sessions are directory-based: `~/.super-multica/sessions/<session-id>/`.
## 5. Data and Credentials
## 3. Data and Credentials Workflow
- Default data dir: `~/.super-multica` (override with `SMC_DATA_DIR`)
- Credentials: `~/.super-multica/credentials.json5` (override with `SMC_CREDENTIALS_PATH`)
- Initialize credentials via `pnpm multica credentials init`
## 6. Coding Rules
## 4. Coding Rules
- TypeScript strict mode is enabled; keep types explicit.
- Keep comments in code **English only**.
@ -61,14 +42,14 @@ pnpm test
- Avoid broad refactors unless required by the task.
- Keep docs concise and aligned with current code behavior.
## 7. Testing Rules
## 5. Testing Rules
- Test runner: Vitest.
- Mock policy: mock external/third-party dependencies only.
- Do not mock internal modules when real integration can be tested.
- Prefer temp directories and real file I/O for storage-related tests.
## 8. Commit Rules
## 6. Commit Rules
- Use atomic commits grouped by logical intent.
- Conventional format:
@ -79,14 +60,14 @@ pnpm test
- `test(scope): ...`
- `chore(scope): ...`
## 9. Minimum Pre-Push Checks
## 7. Minimum Pre-Push Checks
```bash
pnpm typecheck
pnpm test
```
## 10. E2E Docs
## 8. E2E Process Docs
- `docs/e2e-testing-guide.md`
- `docs/e2e-finance-benchmark.md`