Skip to content

Commit f028b8d

Browse files
authored
docs(overview): add concise guide for AI agents (#4116)
1 parent f05e7c1 commit f028b8d

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

AI_OVERVIEW.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Repository Overview for AI Agents
2+
3+
This document gives a condensed view of the project structure and build process so that AI tools (like Codex) can reason about the codebase without scanning every file.
4+
5+
## Project Structure
6+
7+
- **`src/`** – TypeScript source files for the library. The entry point is [`wavesurfer.ts`](../src/wavesurfer.ts). Other files implement features such as the player, plugins, and utilities.
8+
- **`examples/`** – Stand‑alone demos used for manual testing and documentation. Each example is an HTML page importing the library and demonstrating a specific feature.
9+
- **`cypress/`** – End‑to‑end and visual regression tests powered by Cypress. Tests live in `cypress/e2e` and snapshots reside in `cypress/snapshots`.
10+
- **`scripts/`** – Helper scripts for cleaning the build directory and creating new plugins.
11+
- **Root config files**`package.json` defines the build, lint, and test commands. TypeScript configuration is in `tsconfig.json`, and linting rules are in `.eslintrc` and `.prettierrc`.
12+
13+
## Common Tasks
14+
15+
- **Install dependencies**: `yarn`
16+
- **Run the dev server**: `yarn start` (compiles TypeScript in watch mode and serves examples on <http://localhost:9090>)
17+
- **Build for production**: `yarn build`
18+
- **Run lint checks**: `yarn lint`
19+
- **Run Cypress tests**: `yarn cypress`
20+
21+
## Contribution Notes
22+
23+
- Follow the coding conventions in [`AGENTS.md`](../AGENTS.md).
24+
- Do not commit generated files from `dist/` or `node_modules/`.
25+
26+
This overview should help an AI agent quickly locate relevant source files and scripts without traversing the entire repository.

0 commit comments

Comments
 (0)