|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +This monorepo contains the Doom documentation tool, export functionality, and related packages. Doom is a documentation generator built on top of Rspress. |
| 4 | + |
| 5 | +## Setup |
| 6 | + |
| 7 | +- Install dependencies: `yarn install` |
| 8 | +- Node.js 18.17.0+ (but not 20.0.0, use 20.1.0+) |
| 9 | + |
| 10 | +## Commands |
| 11 | + |
| 12 | +- **Build**: `yarn build` (clean and compile TypeScript) |
| 13 | +- **Clean**: `yarn clean` (clean TypeScript build artifacts) |
| 14 | +- **Dev**: `yarn dev` (development mode with file watching) |
| 15 | +- **Docs**: `yarn docs` (build and export docs) | `yarn docs:build` | `yarn docs:export` |
| 16 | +- **Format**: `yarn format` (format code with Prettier) |
| 17 | +- **Lint**: `yarn lint` (ESLint check) |
| 18 | +- **Serve**: `yarn serve` (serve built documentation) |
| 19 | +- **Test**: `yarn typecov` (type coverage check) |
| 20 | +- **Release**: `yarn release` (build and publish packages) |
| 21 | +- **Workspace**: `yarn workspaces list` (list packages) | `yarn workspace <name> <command>` |
| 22 | + |
| 23 | +## Code style |
| 24 | + |
| 25 | +- **Formatting**: Prettier configuration |
| 26 | +- **Types**: TypeScript strict mode |
| 27 | +- **Linting**: ESLint with project-specific rules |
| 28 | +- **Naming**: Follow existing patterns in the codebase |
| 29 | + |
| 30 | +## Architecture |
| 31 | + |
| 32 | +- **Structure**: Monorepo (Yarn workspaces) |
| 33 | + - `packages/doom/`: Main documentation tool and CLI |
| 34 | + - `packages/export/`: Document export functionality |
| 35 | + - `docs/`: Project documentation |
| 36 | + - `fixture-docs/`: Test documentation |
| 37 | +- **Testing**: Type coverage validation (`yarn typecov`) |
| 38 | +- **Configuration**: |
| 39 | + - `doom.config.yml`: Main configuration |
| 40 | + - `tsconfig.json`: TypeScript configuration |
| 41 | + - `eslint.config.js`: Linting rules |
0 commit comments