|
| 1 | +--- |
| 2 | +applyTo: "**" |
| 3 | +--- |
| 4 | + |
| 5 | +# Overview |
| 6 | + |
| 7 | +Documentation management system with client library, API server, and web studio interface. |
| 8 | + |
| 9 | +## Directory Structure |
| 10 | + |
| 11 | +### Root |
| 12 | +- `mcp.ts` - MCP (Model Context Protocol) implementation |
| 13 | +- `index.dev.ts` - Development entry point |
| 14 | +- `init.ts` - Initialization script |
| 15 | + |
| 16 | +### packages/ |
| 17 | + |
| 18 | +#### docs-client/ |
| 19 | +Documentation client library for file management and processing |
| 20 | + |
| 21 | +- `lib/` - Core library |
| 22 | + - `entities/` - Document entities (file, index, markdown) |
| 23 | + - `doc-file-entity.ts` - Base file entity |
| 24 | + - `doc-file-index-entity.ts` - Index file entity |
| 25 | + - `doc-file-md-entity.ts` - Markdown file entity |
| 26 | + - `doc-file-unknown-entity.ts` - Unknown file type entity |
| 27 | + - `values/` - Value objects |
| 28 | + - `doc-custom-schema-field/` - Custom field implementations |
| 29 | + - `doc-meta-field/` - Meta field implementations |
| 30 | + - `doc-schema-field/` - Schema field implementations |
| 31 | + - Tree and path value objects |
| 32 | + - `doc-client.ts` - Main client API |
| 33 | + - `doc-file-system.ts` - File system operations |
| 34 | + - `doc-markdown-system.ts` - Markdown processing |
| 35 | + - `doc-schema-builder.ts` - Schema construction |
| 36 | + - Reference implementations for directories and files |
| 37 | + |
| 38 | +#### docs-router/ |
| 39 | +API server using Hono framework |
| 40 | + |
| 41 | +- `lib/` - Server implementation |
| 42 | + - `routes/` - API endpoints |
| 43 | + - `directories.$path.ts` - Directory operations |
| 44 | + - `directories.tree.ts` - Directory tree operations |
| 45 | + - `files.$path.ts` - File operations |
| 46 | + - `files.ts` - File listing |
| 47 | + - `utils/` - Server utilities |
| 48 | + - `cwd.ts` - Working directory utilities |
| 49 | + - `factory.ts` - Handler factory |
| 50 | + - `client.ts` - API client |
| 51 | + - `env.ts` - Environment configuration |
| 52 | +- `server.ts` - Server entry point |
| 53 | + |
| 54 | +#### docs-studio/ |
| 55 | +React-based web interface |
| 56 | + |
| 57 | +- `app/` - React application |
| 58 | + - `components/` - UI components |
| 59 | + - `ui/` - Base UI components (shadcn/ui) |
| 60 | + - `file-view/` - File viewing/editing components |
| 61 | + - `project-view/` - Project management views |
| 62 | + - `editable-table-cell/` - Table cell editors |
| 63 | + - `hooks/` - Custom React hooks |
| 64 | + - `routes/` - TanStack Router routes |
| 65 | + - `lib/` - Frontend utilities |
| 66 | + - `open-csv/` - CSV processing |
| 67 | + - `api-client.ts` - API client wrapper |
0 commit comments