Skip to content

Commit c75364e

Browse files
Refactor documentation structure by consolidating and updating agent skills and rules. Remove outdated cursor rules and enhance clarity in AGENTS.md, skills, and testing documentation for improved developer onboarding and contribution processes.
1 parent a487c79 commit c75364e

14 files changed

Lines changed: 313 additions & 354 deletions

File tree

.cursor/rules/README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,5 @@
1-
# Cursor rules — `@contentstack/datasync-mongodb-sdk`
1+
# Cursor (optional)
22

3-
This directory contains project-specific rules for AI assistants and developers. Rules use YAML frontmatter with `description`, and optionally `globs` and/or `alwaysApply`.
3+
**Cursor** users: start at the repo root **[`AGENTS.md`](../../AGENTS.md)**. All conventions live in **`skills/*/SKILL.md`** (universal for any editor or tool).
44

5-
## How to use
6-
7-
- Rules with **`alwaysApply: true`** are intended to be loaded in relevant sessions automatically (depending on your Cursor settings).
8-
- Rules with **globs** apply when editing matching files.
9-
- For rules without `alwaysApply`, reference them explicitly when needed, e.g. **`@dev-workflow`**, **`@typescript`**, **`@datasync-mongodb`**, **`@testing`**, **`@code-review`** (use the file base name as shown in your Cursor UI).
10-
11-
## Rule index
12-
13-
| File | alwaysApply | Globs | When it applies |
14-
|------|-------------|-------|-----------------|
15-
| [dev-workflow.md](./dev-workflow.md) | No | *(none)* | Branching, scripts, PR/release expectations, security hooks |
16-
| [typescript.mdc](./typescript.mdc) | No | `src/**/*.ts`, `typings/**/*.ts` | TypeScript style, layout, TSLint alignment |
17-
| [datasync-mongodb.mdc](./datasync-mongodb.mdc) | No | `src/**/*.ts` | DataSync MongoDB SDK patterns (Stack, config, MongoDB — not CDA/CMA) |
18-
| [testing.mdc](./testing.mdc) | No | `test/**/*.ts`, `jest.config.js` | Jest tests, MongoDB integration tests, fixtures |
19-
| [code-review.mdc](./code-review.mdc) | **Yes** | *(global)* | PR checklist, terminology (DataSync vs CDA/CMA) |
20-
21-
## Related
22-
23-
- Root agent entry point: [../../AGENTS.md](../../AGENTS.md) (repository root)
24-
- Skills index: [../../skills/README.md](../../skills/README.md)
5+
This folder **only** contains this **README** — no `.mdc` or other rule files — so nothing editor-specific duplicates the canonical docs.

.cursor/rules/code-review.mdc

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

.cursor/rules/datasync-mongodb.mdc

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

.cursor/rules/dev-workflow.md

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

.cursor/rules/testing.mdc

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

.cursor/rules/typescript.mdc

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

0 commit comments

Comments
 (0)