Commit d288659
authored
docs: add agent runtime primer (#145)
#### Overview
Adds a first-time Agent Runtime Primer so users can understand what NeMo Relay adds before running Quick Start.
- [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license.
- [x] I searched existing issues and open pull requests, and this does not duplicate existing work.
#### Details
- Adds `docs/getting-started/agent-runtime-primer.md` to explain scopes, managed tool and LLM calls, middleware, events, subscribers/exporters, and plugins.
- Clarifies that NeMo Relay does not replace agent frameworks, model providers, application logic, observability backends, or NeMo Agent Toolkit.
- Links the page from the docs overview and Getting Started navigation.
Validation: `just docs`, `just docs-linkcheck`, `git diff --check`. `uv run pre-commit run --all-files` was also run; all unrelated hooks passed.
#### Where should the reviewer start?
`docs/getting-started/agent-runtime-primer.md`
#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
- N/A
## Summary by CodeRabbit
* **Documentation**
* Added an Agent Runtime Primer detailing the agent runtime execution model: scopes, managed tool/LLM calls, middleware, lifecycle events, and plugins.
* Clarifies what NeMo Relay does not replace and offers guidance on selecting instrumentation boundaries (application-owned, framework-owned, or reusable plugin behavior).
* Updated docs navigation to include the new Getting Started entry for the primer.
[](https://app.coderabbit.ai/change-stack/NVIDIA/NeMo-Relay/pull/145?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)
Authors:
- https://github.com/mnajafian-nv
Approvers:
- Will Killian (https://github.com/willkill07)
URL: #1451 parent 7fbe239 commit d288659
2 files changed
Lines changed: 104 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| 60 | + | |
60 | 61 | | |
61 | 62 | | |
62 | 63 | | |
| |||
143 | 144 | | |
144 | 145 | | |
145 | 146 | | |
| 147 | + | |
146 | 148 | | |
147 | 149 | | |
148 | 150 | | |
| |||
0 commit comments