Skip to content

README.md

Latest commit

 

History

History
90 lines (71 loc) · 5.75 KB

README.md

File metadata and controls

90 lines (71 loc) · 5.75 KB

Agent Topic Lab Documentation

This directory contains product-level documentation for the integrated TopicLab stack. For Resonnet implementation details, see ../backend/docs/README.md.

Directory Structure

docs/
├── getting-started/     # Setup and deployment
├── architecture/        # System design and performance
├── features/            # Feature flows and specs
├── api/                 # External API references
└── design/              # UI/UX design system

Documentation Conventions

  • Keep docs aligned with the current service boundary: topiclab-backend owns business state, Resonnet owns execution and workspace artifacts.
  • When API paths, environment variables, or integration flows change, update CHANGELOG.md and the nearest README/doc entry together.
  • Prefer adding focused docs under the relevant subdirectory instead of expanding the root README with feature-specific detail.
  • topiclab-cli now lives as a git submodule in the repo root. Local OpenClaw/CLI protocol verification should use the Docker smoke wrapper instead of ad-hoc curl scripts.

Getting Started

Document Description
quickstart.md Quick start guide (Docker / local development)
config.md Environment variables and configuration
deploy.md Deploy via GitHub Actions; DEPLOY_ENV secret setup

Architecture & Technical

Document Description
technical-report.md System overview, interaction flow, code paths, API, data models
openclaw-cli-first.md CLI-first TopicLab local runtime, thin OpenClaw bridge, and agent-facing command contract
openclaw-digital-twin-runtime.md Digital twin runtime, scene overlays, and V1 user-requirement event accumulation between TopicLab and OpenClaw
openclaw-topiclab-api-schema.md Concrete API schema, table design, and migration draft for TopicLab-side OpenClaw CLI support
topic-service-boundary.md Service boundary: TopicLab Backend vs Resonnet
topiclab-performance-optimization.md Pagination, optimistic UI, short-TTL cache, delayed rendering

Features & Flows

Document Description
arcade-arena.md Arcade task model, metadata contract, OpenClaw flow, evaluator APIs
community-operations-observability.md Community operations metrics, dashboard design, telemetry gaps, and implementation roadmap
digital-twin-lifecycle.md Digital twin lifecycle: create, publish, share, history
points-system.md Points system: wallet, ledger, settlement rules, surfaces, and current mismatches
share-flow-sequence.md Share flow sequence diagrams (expert / moderator mode library)
request-category.md Request category for publishing requests and resource matching

API Reference

Document Description
academic-literature-api-overview.md Literature (Academic) tab read-only API
aminer-open-api-limits.md AMiner Open Platform free-tier API

Design System

Document Description
frontend-design-guide.md Visual language, component specs, implementation conventions
openclaw-auth-sequences.md OpenClaw auth, binding, recovery, and app catalog discovery timelines
shape-system.md Unified border-radius specification
color-system.md Unified color token specification
home-card-lighting-system.md Homepage card palette families, lighting logic, and active-card environment behavior
tashan-homepage-style-guide.md Tashan homepage UI specification (separate product)
style-refactor-checklist.md Page and component refactor checklist

Quick Navigation