Skip to content

Commit a090a13

Browse files
committed
chore: Refactor project standards and documentation
- Removed the obsolete `.cursorrules` file to streamline project structure. - Updated various documentation files to emphasize the importance of reading `ai_docs/` for project standards. - Clarified references to backend and frontend standards, ensuring consistency across all relevant documents. - Enhanced the `AI_TOOLING_STANDARDS.md` with a comprehensive index of all related documents for better accessibility.
1 parent 858fab8 commit a090a13

File tree

19 files changed

+30
-672
lines changed

19 files changed

+30
-672
lines changed

.agents/rules/project-development.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
trigger: always_on
33
---
44

5-
Follow `ai_docs/AI_TOOLING_STANDARDS.md` as the default engineering contract.
5+
**Read `ai_docs/` for project standards.** `ai_docs/AI_TOOLING_STANDARDS.md` has the full docs index.
66

77
- Plan before implementation and keep edits minimal.
8-
- Prefer Python 3.10+ + uv + ruff + pytest for backend tasks.
9-
- For backend API/service design, follow `ai_docs/BACKEND_STANDARDS.md`.
8+
- Backend rules: `ai_docs/BACKEND_STANDARDS.md`.
9+
- Frontend rules: `ai_docs/FRONTEND_STANDARDS.md`.
10+
- Scripts (rename/version): `ai_docs/SCRIPTS_GUIDE.md`.
1011
- Use explicit typing and predictable error handling.
1112
- Do not claim completion without relevant verification commands.
12-
- Frontend stack: pnpm + React + TypeScript + Vite + Tailwind CSS + shadcn/ui.

.agents/skills/project-development-playbook/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: Use when implementing project tasks that need consistent coding sta
88

99
Apply one consistent delivery workflow across backend and frontend tasks.
1010

11+
**Reference:** Read `ai_docs/AI_TOOLING_STANDARDS.md` for the full docs index before starting.
12+
1113
## Workflow
1214

1315
1. Confirm scope and assumptions.

.claude/skills/project-development-playbook/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: Use when implementing project tasks that need consistent coding sta
88

99
Apply one consistent delivery workflow across backend and frontend tasks.
1010

11+
**Reference:** Read `ai_docs/AI_TOOLING_STANDARDS.md` for the full docs index before starting.
12+
1113
## Workflow
1214

1315
1. Confirm scope and assumptions.

.codex/skills/project-development-playbook/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: Use when implementing project tasks that need consistent coding sta
88

99
Apply one consistent delivery workflow across backend and frontend tasks.
1010

11+
**Reference:** Read `ai_docs/AI_TOOLING_STANDARDS.md` for the full docs index before starting.
12+
1113
## Workflow
1214

1315
1. Confirm scope and assumptions.

.cursor/rules/backend-python-service-standards.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Backend service/API standards for Python projects using typed models, clear layering, and reliable verification.
33
globs: src/**/*.py, tests/**/*.py
44
---
5-
- For backend API/service work, follow `ai_docs/BACKEND_STANDARDS.md`.
5+
- For backend API/service work, follow `ai_docs/BACKEND_STANDARDS.md`. See `ai_docs/AI_TOOLING_STANDARDS.md` for full docs index.
66
- Use layered boundaries: API -> service -> repository -> domain.
77
- Keep route handlers thin; place business logic in service layer.
88
- Use Pydantic v2 models for request/response and validation.

.cursor/rules/frontend-react-typescript-vite-tailwind.mdc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Default frontend stack and implementation standards for this project.
33
globs: frontend/**/*.{html,css,js,jsx,ts,tsx,json}
44
---
5+
- **Follow `ai_docs/FRONTEND_STANDARDS.md` for full frontend conventions.**
56
- Fixed stack: **pnpm** + React + TypeScript + Vite + Tailwind CSS + **shadcn/ui**.
67
- Use shadcn/ui as the component library; customise via Tailwind and CSS variables.
78
- Build reusable UI primitives in `frontend/src/components/ui`.

.cursor/rules/project-development-standards.mdc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
description: Project-wide engineering contract across backend and frontend work.
33
globs: **/*
44
---
5-
- Follow `ai_docs/AI_TOOLING_STANDARDS.md` for workflow and quality gates.
6-
- Follow `ai_docs/BACKEND_STANDARDS.md` when implementing backend API/service behavior.
5+
- **Read `ai_docs/` for project standards.** `ai_docs/AI_TOOLING_STANDARDS.md` has the full index.
6+
- Backend: `ai_docs/BACKEND_STANDARDS.md`. Frontend: `ai_docs/FRONTEND_STANDARDS.md`.
7+
- Scripts (rename/version): `ai_docs/SCRIPTS_GUIDE.md`.
78
- Plan first, implement minimal changes, and verify before completion.
89
- Backend default: Python 3.10+, uv, ruff, pytest.
10+
- Frontend default: pnpm + React + TypeScript + Vite + Tailwind CSS + shadcn/ui.
911
- Keep functions typed, explicit, and testable.
1012
- Handle failures explicitly; avoid silent exception swallowing.

.cursor/skills/project-development-playbook/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Apply one consistent delivery workflow across backend and frontend tasks.
44

5+
**Reference:** Read `ai_docs/AI_TOOLING_STANDARDS.md` for the full docs index before starting.
6+
57
## Workflow
68

79
1. Confirm scope and assumptions.

.cursorrules

Lines changed: 0 additions & 10 deletions
This file was deleted.

AGENTS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ Use this file as the default project contract for Codex.
1111

1212
## Engineering Rules
1313

14-
- Follow `ai_docs/AI_TOOLING_STANDARDS.md`.
15-
- Follow `ai_docs/BACKEND_STANDARDS.md` for backend API/service tasks.
16-
- Prefer Python 3.10+ + uv + ruff + pytest for backend work.
14+
- **Read `ai_docs/` for project standards before starting work.**
15+
- Core contract: `ai_docs/AI_TOOLING_STANDARDS.md` (contains full index of all docs).
16+
- Backend rules: `ai_docs/BACKEND_STANDARDS.md`.
17+
- Frontend rules: `ai_docs/FRONTEND_STANDARDS.md`.
18+
- Scripts (rename/version): `ai_docs/SCRIPTS_GUIDE.md`.
1719
- Keep functions small, typed, and testable.
1820
- Handle errors explicitly; avoid silent failures.
1921

0 commit comments

Comments
 (0)