You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .cursor/rules/documentation/general.mdc
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -31,17 +31,23 @@ Follow these rules when working with any documentation in the NeMo Agent toolkit
31
31
32
32
### Terminology and Naming
33
33
- Make sure to follow this naming convention for all the documentation. If there is any documentation not following this rule, you MUST update it.
34
-
- **Full name on first use**: "NVIDIA NeMo Agent toolkit"
35
-
- **Subsequent references**: "NeMo Agent toolkit"
36
-
- **Abbreviations**: "NAT" or "nat"
37
-
- "nat" for the API namespace and CLI tool
38
-
- "nvidia-nat" for the package name
39
-
- "NAT" for environment variable prefixes, and informal usage in comments
40
-
- This should be used for all abbreviations in the comments in the code.
41
-
- This should NEVER be used in the documentation.
34
+
- **Full name (first use)**: "NVIDIA NeMo Agent toolkit" — use for document titles, webpage headers, and any public descriptions
35
+
- **Short name (subsequent references)**: "NeMo Agent toolkit" or "the toolkit"
36
+
- **Capitalization rules**:
37
+
- In document titles, headings, or any context where all words are capitalized, use "Toolkit" (capital T): e.g., "NVIDIA NeMo Agent Toolkit" or "NeMo Agent Toolkit"
38
+
- In all other contexts (body text, descriptions), use "toolkit" (lowercase t): e.g., "NVIDIA NeMo Agent toolkit" or "NeMo Agent toolkit"
- `NeMo-Agent-Toolkit` for URLs, directory names, and contexts where capitalization is preserved (no underscores or spaces)
44
+
- **"NAT" abbreviation**:
45
+
- OK in code comments
46
+
- NEVER use "NAT" or "nat" to refer to the toolkit in documentation
42
47
- Examples:
43
48
- "In the NeMo Agent toolkit, you can…"
44
49
- "Change directory to the NeMo Agent toolkit repo root…"
50
+
- Heading: "# Getting Started with NeMo Agent Toolkit"
45
51
- Consistently use this terminology throughout all documentation
46
52
- NeMo Agent toolkit was previously known as the Agent Intelligence toolkit, and AgentIQ. You should NEVER use the deprecated names, including Agent Intelligence toolkit, aiqtoolkit, AgentIQ, or AIQ/aiq. If you see any of these names in the documentation, you MUST update it based on the latest naming convention above, unless those names are intentionally used to refer to the deprecated names, or implementing a compatibility layer for the deprecated names.
Copy file name to clipboardExpand all lines: .cursor/rules/general.mdc
+14-9Lines changed: 14 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -13,18 +13,23 @@ These are the overarching standards that every **source, test, documentation and
13
13
## Terminology and Naming
14
14
15
15
- Make sure to follow this naming convention for all the documentation. If there is any documentation not following this rule, you MUST update it.
16
-
- **Full name on first use**: "NVIDIA NeMo Agent toolkit"
17
-
- **Subsequent references**: "NeMo Agent toolkit"
18
-
- If the name is part of a heading, use "NeMo Agent Toolkit" in the heading. Capitalize the "T" in "Toolkit".
19
-
- **Abbreviations**: "NAT" or "nat"
20
-
- "nat" for the API namespace and CLI tool
21
-
- "nvidia-nat" for the package name
22
-
- "NAT" for environment variable prefixes, and informal usage in comments
23
-
- This should be used for all abbreviations in the comments in the code.
24
-
- This should NEVER be used in the documentation.
16
+
- **Full name (first use)**: "NVIDIA NeMo Agent toolkit" — use for document titles, webpage headers, and any public descriptions
17
+
- **Short name (subsequent references)**: "NeMo Agent toolkit" or "the toolkit"
18
+
- **Capitalization rules**:
19
+
- In document titles, headings, or any context where all words are capitalized, use "Toolkit" (capital T): e.g., "NVIDIA NeMo Agent Toolkit" or "NeMo Agent Toolkit"
20
+
- In all other contexts (body text, descriptions), use "toolkit" (lowercase t): e.g., "NVIDIA NeMo Agent toolkit" or "NeMo Agent toolkit"
- `NeMo-Agent-Toolkit` for URLs, directory names, and contexts where capitalization is preserved (no underscores or spaces)
26
+
- **"NAT" abbreviation**:
27
+
- OK in code comments
28
+
- NEVER use "NAT" or "nat" to refer to the toolkit in documentation
25
29
- Examples:
26
30
- "In the NeMo Agent toolkit, you can…"
27
31
- "Change directory to the NeMo Agent toolkit repo root…"
32
+
- Heading: "# Getting Started with NeMo Agent Toolkit"
28
33
- Consistently use this terminology throughout all documentation
29
34
- NeMo Agent toolkit was previously known as the Agent Intelligence toolkit, and AgentIQ. You should NEVER use the deprecated names, including Agent Intelligence toolkit, aiqtoolkit, AgentIQ, or AIQ/aiq. If you see any of these names in the documentation, you should update it based on the latest naming convention above, unless those names are intentionally used to refer to the deprecated names, or implementing a compatibility layer for the deprecated names.
Copy file name to clipboardExpand all lines: docs/source/get-started/tutorials/build-a-demo-agent-workflow-using-cursor-rules.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,10 +28,6 @@ Cursor rules in NeMo Agent toolkit act as an intelligent development that offers
28
28
29
29
## Common Prompts
30
30
31
-
:::{note}
32
-
For optimal Cursor rules experience, avoid using the `Auto` mode for LLM model selection. Instead, manually choose a model from the selection menu, such as `claude-4-sonnet`.
33
-
:::
34
-
35
31
The following are frequently used prompts to begin development:
0 commit comments