Skip to content

INDEX.md

Latest commit

 

History

History
55 lines (39 loc) · 4.71 KB

INDEX.md

File metadata and controls

55 lines (39 loc) · 4.71 KB
Raw

Documentation Index

English | 简体中文

Start with the README, QUICK_START.md, and DEMO.md. This index is the compact map for setup, client integration, security, release, and maintenance docs.

Start Here

  1. ../README.md / ../README.zh-CN.md - product overview and positioning.
  2. QUICK_START.md / QUICK_START.zh-CN.md - local-first setup for one server, one agent, one project, and one client.
  3. DEMO.md / DEMO.zh-CN.md - expected safe coding workflow.
  4. CONCEPTS.md / CONCEPTS.zh-CN.md - vocabulary and mental model.
  5. ARCHITECTURE.md - product architecture and Rust module map.

Client Integration

  1. MCP.md / MCP.zh-CN.md - remote MCP endpoint, authentication, default coding loop, read-only LSP and validation intelligence, and common MCP errors.
  2. GPT_ACTIONS.md / GPT_ACTIONS.zh-CN.md - Custom GPT setup, OpenAPI import, authentication, generic validation-summary access, and workflow guidance.
  3. assets/README.md / assets/README.zh-CN.md - screenshots used by MCP and GPT Actions guides.

Setup And Operation

  1. BUILD_INSTALL.md / BUILD_INSTALL.zh-CN.md - build/install command reference and artifact details.
  2. DEPLOYMENT.md / DEPLOYMENT.zh-CN.md - production server bootstrap, HTTPS, systemd, OAuth, QUIC, and smoke checks.
  3. OPERATIONS.md - day-to-day operations, token model, project registration, session workflow, and smoke testing.
  4. TROUBLESHOOTING.md / TROUBLESHOOTING.zh-CN.md - common deployment and integration failures.

Security And Auth

  1. ../SECURITY.md - security model, model capabilities, project boundary, shell/job risk, token handling, audit evidence, revocation, and vulnerability reporting.
  2. AUTH_MODEL.md / AUTH_MODEL.zh-CN.md - shared key, bootstrap token, account credential, PAT, OAuth token, agent token, and hash storage.
  3. OAUTH2_INTERNALS.md - OAuth2 storage, client management, authorize flow, token exchange, revocation, and delegated scope enforcement.
  4. OAUTH2_SMOKE_TEST.md - manual end-to-end OAuth2 validation.
  5. OAUTH2_BRIDGE_THREAT_MODEL.md - shared-key OAuth bridge threat model and subject model constraints.

Agent And Runtime

  1. AGENT_PROJECTS.md / AGENT_PROJECTS.zh-CN.md - agent project registry format and runtime project ids.
  2. AGENT_TRANSPORTS.md / AGENT_TRANSPORTS.zh-CN.md - QUIC, WebSocket, polling, fallback, and transport validation.
  3. AGENT_PROTOCOL.md / AGENT_PROTOCOL.zh-CN.md - agent auth, identity, typed read-only LSP bridge, protocol, and redacted policy summaries.
  4. SHELL_PROFILES.md / SHELL_PROFILES.zh-CN.md - prepared shell environment snapshots and safety boundaries.
  5. LSP_NAVIGATION.md - read-only Rust LSP navigation tools, startup capability summary, boundaries, limits, and error codes.

Release And Roadmap

  1. RELEASE_NOTES_v0.2.0.md - external-facing 0.2.0 release notes.
  2. RELEASE_CHECKLIST.md - release readiness and acceptance procedure.
  3. ROADMAP.md / ROADMAP.zh-CN.md - short roadmap.

Developer Maintenance

  1. TESTING.md - test lanes, test layout, and ignored-test inventory.
  2. E2E_VALIDATION.md / E2E_VALIDATION.zh-CN.md - local end-to-end validation scripts and documentation scan guidance.
  3. ../AGENTS.md - agent execution contract (safety, editing, git, validation, architecture musts).
  4. agent/architecture-decisions.md, agent/session-model.md, agent/session-correlation.md, agent/permission-model.md, agent/oauth-bridge-plan.md, agent/openapi-guidelines.md, agent/release-process.md - long-form design moved out of AGENTS.md (session dual model, optional session correlation, permission decision layer, OAuth bridge, OpenAPI, release).