AGENTS.md

1# AGENTS.md for Awesome-AITools
2 
3This file provides context and instructions for AI coding agents (e.g., Cursor, Aider, Claude Code, Windsurf) to help them understand this repository more effectively. It follows the [AGENTS.md](https://agents.md/) standard.
4 
5## Repository Purpose
6 
7A curated, bilingual (EN/CN) "awesome list" of AI tools — chatbots, agents, skills, CLI tools, and more. There is no application code; the repository's product is the two README files and their supporting `docs/` deep-dives.
8 
9## Key Files & Directories
10 
11- `README.md` — Main tool list (English).
12- `README-CN.md` — Main tool list (Chinese).
13- `docs/<tool-slug>/` — Longer-form intros for individual tools.
14- `CHANGELOG.md` — Monthly log (e.g. `## June 2026`) of additions/removals/renames.
15- `scripts/format_readmes.py` — Maintenance/normalization script.
16 
17## Architecture
18 
19The repo is structured as two parallel, mirrored documents that must stay in sync:
20 
21- `README.md` and `README-CN.md` share the same category structure, the same set of tools, and the same 4-column table schema:
22  - English: `| Name | Description | Links | Fees |`
23  - Chinese: `| 名称 | 说明 | 链接 | 费用 |`
24- README entries with a deep-dive link to `docs/<slug>/` via `[Intro](docs/<slug>/...)` (EN) and `[入门介绍](docs/<slug>/...)` (CN).
25 
26When adding/removing/editing a tool, the change almost always touches **both** READMEs (and often `CHANGELOG.md` and a `docs/` page). A change in only one language is a bug.
27 
28## Commands
29 
30- Format/normalize both READMEs: `python3 scripts/format_readmes.py` (run from anywhere — the script resolves the project root itself). This rewrites tables to the canonical 4-column form, strips ` `, converts `</br>` → `<br>`, dedents tabs, and fixes a couple of known broken TOC anchors. Run it after any table edit.
31- Local link check (requires [lychee](https://github.com/lycheeverse/lychee) installed): `lychee .` — mirrors the CI workflow at `.github/workflows/link-check.yml`. `.lycheeignore` holds the exclusion list.
32 
33There is no build, test, or lint suite beyond the above — CI only runs link checking on `**/*.md`.
34 
35## Editing Conventions
36 
37- When adding a new tool, follow the existing table format in both READMEs.
38- Table format is strict: exactly 4 columns, with the separator row `| --- | --- | --- | --- |`. `format_readmes.py` will rewrite divergent separators, so don't hand-craft 3- or 5-column variants.
39- The TOC at the top of each README lists category anchors. The formatter knows about two specific anchor-typo fixes (`#news-information` in EN, `#gpt-llms应用` in CN) — preserve those exact slugs.
40- When linking to a deep-dive doc, use the EN/CN phrasing pair `[Intro](...)` / `[入门介绍](...)` so both READMEs stay parallel.
41- Keep tool descriptions concise and factual; ensure links are valid.
42- Maintain bilingual consistency between English and Chinese READMEs.
43- **CHANGELOG.md**: Document additions, removals, renames, and notable model updates (e.g., when a chatbot or model entry is refreshed to a new flagship version). Minor description updates (e.g., fixing typos, small feature list tweaks) do NOT require a changelog entry.
44