| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 5 | 9 | 0% |
| Commands | 0 | 0 | 2 | 0% |
| Section tags | 2 | 0 | 1 | 67% |
What each file covers
Sections
0 shared · 5 only in A · 9 only in B- − Mintlify Steps and in-page anchors
- − Do this
- − Run the agent locally
- − Do not do this
- − Pattern reference
- + AGENTS.md
- + Cursor Cloud specific instructions
- + Build
- + AI Boundaries
- + Always
- + Ask First
- + Never
- + Developer-local agent config
- + Novu Distribution
Commands
0 shared · 0 only in A · 2 only in B- + pnpm setup:agent
- + pnpm build
Section tags
2 shared · 0 only in A · 1 only in B- + build
- do-not
- agent-behaviour
Line diff
novuhq/novu · .cursor/rules/docs-mintlify-steps.mdc
@@ −1 @@
1---
2description: Mintlify Steps anchors — use markdown headings inside Step so in-page links work
3globs: docs/**/*.mdx
4alwaysApply: false
5---
6
7# Mintlify Steps and in-page anchors
8
9Mintlify `<Step title="...">` does **not** create a heading ID. Links like `#run-the-agent-locally` will do nothing if they target a Step `title` prop.
10
11## Do this
12
13Put a real markdown heading inside `<Step>` when anything needs to link to that step (or when you want TOC/anchor support):
14
15```mdx
16<Steps>
17 <Step>
18## Run the agent locally
19
20Content here.
21 </Step>
22</Steps>
23```
24
25Then link with:
26
27```mdx
28skip to [Run the agent locally](#run-the-agent-locally)
29```
30
31## Do not do this
32
33```mdx
34{/* ❌ title prop is not an anchor target */}
35<Step title="Run the agent locally">
36...
37</Step>
38
39skip to [Run the agent locally](#run-the-agent-locally)
40```
41
42## Pattern reference
43
44See `docs/agents/custom-code-agent/quickstart.mdx` and `docs/agents/get-started/ai-sdk.mdx` for working examples.
45
novuhq/novu · AGENTS.md
@@ +1 @@
1# AGENTS.md
2
3## Cursor Cloud specific instructions
4
5`pnpm setup:agent` has already been run. Do not run it again. The environment is fully configured: dependencies installed, enterprise packages linked, project built, `.env` files in place, Docker services running, and a default user/org seeded. The dashboard auto signs in the pre-seeded agent user when opened in the browser (no manual login unless auto sign-in fails).
6
7## Build
8
9Run `pnpm build` after changes to `packages/` or `enterprise/`. Direct changes to `apps/` do not require a rebuild.
10
11## AI Boundaries
12
13### Always
14- Work within: `apps/api`, `apps/dashboard`, `apps/worker`, `apps/ws`
15- Use shared packages: `packages/shared`, `packages/framework`, `packages/js`, `packages/react`
16- Follow `libs/dal` for data access, `libs/application-generic` for business logic
17
18### Ask First
19- Before creating new UI components not in `apps/dashboard/src/components/`
20- Before adding npm dependencies
21- Before modifying MongoDB models, ClickHouse table definitions, or anything in `enterprise/` or `packages/providers/`
22
23### Never
24- Inactive apps — do not touch, unless monorepo wide refactor: `apps/webhook`
25- Auto-generated — never edit: `libs/internal-sdk`
26- UI: reuse existing Radix/shadcn components only; do not copy patterns from `playground/` into production code
27- If doing a monorepo wide refactor, you can touch the read only, but only when necessary.
28
29
30## Developer-local agent config
31
32If a **`.agents-local/`** directory exists in your working copy, read **`.agents-local/README.md`** first for personal, git-ignored agent configuration, skills and rules. Absence of the directory is normal.
33
34## Novu Distribution
35Novu is distributed in 3 modes, Community Edition, Enterprise Cloud Edition, and On-Prem Enterprise Edition.
36
37When making changes targeted to the Enterprise distribution, we need to make sure that the changes are not breaking the Community edition, and are properly gated behind a flag, or the novu enterpise env variables. Similarly when some changes are only targeting the Cloud, self-hosted on prem should not be affected.
38
39<!-- Infrastructure & services: see .cursor/rules/infrastructure.mdc -->
40<!-- Dependency graph: see .cursor/rules/dependency-graph.mdc -->
41<!-- Testing: see .cursor/rules/testing.mdc -->
42<!-- PR format: see .cursor/rules/pullrequest.mdc -->
43<!-- Enterprise submodule: see .cursor/skills/enterprise-submodule/SKILL.md -->
44
@@ −1 +1 @@
1−---
2−description: Mintlify Steps anchors — use markdown headings inside Step so in-page links work
3−globs: docs/**/*.mdx
4−alwaysApply: false
5−---
1+# AGENTS.md
62
7−# Mintlify Steps and in-page anchors
3+## Cursor Cloud specific instructions
84
9−Mintlify `<Step title="...">` does **not** create a heading ID. Links like `#run-the-agent-locally` will do nothing if they target a Step `title` prop.
5+`pnpm setup:agent` has already been run. Do not run it again. The environment is fully configured: dependencies installed, enterprise packages linked, project built, `.env` files in place, Docker services running, and a default user/org seeded. The dashboard auto signs in the pre-seeded agent user when opened in the browser (no manual login unless auto sign-in fails).
106
11−## Do this
7+## Build
128
13−Put a real markdown heading inside `<Step>` when anything needs to link to that step (or when you want TOC/anchor support):
9+Run `pnpm build` after changes to `packages/` or `enterprise/`. Direct changes to `apps/` do not require a rebuild.
1410
15−```mdx
16−<Steps>
17− <Step>
18−## Run the agent locally
11+## AI Boundaries
1912
20−Content here.
21− </Step>
22−</Steps>
23−```
13+### Always
14+- Work within: `apps/api`, `apps/dashboard`, `apps/worker`, `apps/ws`
15+- Use shared packages: `packages/shared`, `packages/framework`, `packages/js`, `packages/react`
16+- Follow `libs/dal` for data access, `libs/application-generic` for business logic
2417
25−Then link with:
18+### Ask First
19+- Before creating new UI components not in `apps/dashboard/src/components/`
20+- Before adding npm dependencies
21+- Before modifying MongoDB models, ClickHouse table definitions, or anything in `enterprise/` or `packages/providers/`
2622
27−```mdx
28−skip to [Run the agent locally](#run-the-agent-locally)
29−```
23+### Never
24+- Inactive apps — do not touch, unless monorepo wide refactor: `apps/webhook`
25+- Auto-generated — never edit: `libs/internal-sdk`
26+- UI: reuse existing Radix/shadcn components only; do not copy patterns from `playground/` into production code
27+- If doing a monorepo wide refactor, you can touch the read only, but only when necessary.
3028
31−## Do not do this
3229
33−```mdx
34−{/* ❌ title prop is not an anchor target */}
35−<Step title="Run the agent locally">
36−...
37−</Step>
30+## Developer-local agent config
3831
39−skip to [Run the agent locally](#run-the-agent-locally)
40−```
32+If a **`.agents-local/`** directory exists in your working copy, read **`.agents-local/README.md`** first for personal, git-ignored agent configuration, skills and rules. Absence of the directory is normal.
4133
42−## Pattern reference
34+## Novu Distribution
35+Novu is distributed in 3 modes, Community Edition, Enterprise Cloud Edition, and On-Prem Enterprise Edition.
4336
44−See `docs/agents/custom-code-agent/quickstart.mdx` and `docs/agents/get-started/ai-sdk.mdx` for working examples.
37+When making changes targeted to the Enterprise distribution, we need to make sure that the changes are not breaking the Community edition, and are properly gated behind a flag, or the novu enterpise env variables. Similarly when some changes are only targeting the Cloud, self-hosted on prem should not be affected.
38+
39+<!-- Infrastructure & services: see .cursor/rules/infrastructure.mdc -->
40+<!-- Dependency graph: see .cursor/rules/dependency-graph.mdc -->
41+<!-- Testing: see .cursor/rules/testing.mdc -->
42+<!-- PR format: see .cursor/rules/pullrequest.mdc -->
43+<!-- Enterprise submodule: see .cursor/skills/enterprise-submodule/SKILL.md -->
4544
