Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
3590c67
Cleanup source install instructions
dagardner-nv Jul 21, 2026
b12d563
Add a shield bar
dagardner-nv Jul 21, 2026
b0fed46
Add shiled bar to pypi readme, NOTE: this won't be able to find the r…
dagardner-nv Jul 21, 2026
20bd835
Ignore the harbor run directories
dagardner-nv Jul 21, 2026
2b122d8
Remove the NVIDIA from the product name as it is already in the H1
dagardner-nv Jul 21, 2026
409187d
Move the image above the elevator-pitch statement. Incorporate the de…
dagardner-nv Jul 21, 2026
b793a04
Install runtime not the meta package
dagardner-nv Jul 21, 2026
4a481ee
Make the quickstart quicker
dagardner-nv Jul 21, 2026
4b5dab9
WIP
dagardner-nv Jul 21, 2026
31354be
Fabric is deployed on pypi
dagardner-nv Jul 22, 2026
7c790f9
Trim down the top level readme into an end-user focused elevator pitch
dagardner-nv Jul 22, 2026
50fd396
docs: clarify README onboarding and integrations
AnuradhaKaruppiah Jul 23, 2026
f53fa0e
docs: organize integration guides by direction
AnuradhaKaruppiah Jul 23, 2026
876f444
docs: organize integration skills by direction
AnuradhaKaruppiah Jul 23, 2026
7552b10
List supported platforms
dagardner-nv Jul 23, 2026
64122bf
Merge branch 'david-docs-refactor-readme-b2' into docs/david-readme-p…
dagardner-nv Jul 23, 2026
6d78741
Merge pull request #1 from AnuradhaKaruppiah/docs/david-readme-polish
dagardner-nv Jul 23, 2026
befc786
Add supported platforms
dagardner-nv Jul 23, 2026
8102429
Move the badge bar
dagardner-nv Jul 23, 2026
470cb7b
Update readme test
dagardner-nv Jul 23, 2026
f88ddac
Update test
dagardner-nv Jul 23, 2026
238133b
Update skills to encourage relative links not Fern absolute links
dagardner-nv Jul 23, 2026
49f569c
Use relative links
dagardner-nv Jul 23, 2026
6b9acc1
Use relative links in generated api docs
dagardner-nv Jul 23, 2026
6924118
Merge branch 'david-repo-neutral-links' into david-docs-refactor-read…
dagardner-nv Jul 23, 2026
31dbf87
Add test
dagardner-nv Jul 23, 2026
8dca028
Use relative path to dist dir
dagardner-nv Jul 23, 2026
4c30bfe
Wrap line
dagardner-nv Jul 23, 2026
c810c8f
Add lead-in
dagardner-nv Jul 23, 2026
4ba29f0
Applying suggestions from LL
dagardner-nv Jul 23, 2026
3467c37
Applying suggestions from LL
dagardner-nv Jul 23, 2026
e489a6e
Update skills/README.md
dagardner-nv Jul 23, 2026
036cb17
Applying suggestions from LL
dagardner-nv Jul 23, 2026
70a65b9
Applying suggestions from LL
dagardner-nv Jul 23, 2026
805e410
Fix config setting
dagardner-nv Jul 23, 2026
cf51584
Add install/config instructions
dagardner-nv Jul 23, 2026
f18517d
Add install/config instructions
dagardner-nv Jul 23, 2026
4b3d6db
Add missing runtime dep for the quickstartm clarify hermes vs hermes-…
dagardner-nv Jul 23, 2026
a29ed4e
Clarify statement
dagardner-nv Jul 23, 2026
c500319
Apply suggestion from Abhishek
dagardner-nv Jul 24, 2026
003f380
docs: pass repository base directory in quickstart
zhongxuanwang-nv Jul 24, 2026
e50a183
Update graphic
dagardner-nv Jul 24, 2026
cdcaf64
Merge branch 'david-docs-refactor-readme-b2' of github.com:dagardner-…
dagardner-nv Jul 24, 2026
4e77c31
Merge branch 'main' of github.com:NVIDIA/NeMo-Fabric into david-docs-…
dagardner-nv Jul 24, 2026
f922446
Update doc apis
dagardner-nv Jul 24, 2026
783f6d0
Updatge elevator pitch sentence
dagardner-nv Jul 24, 2026
0131fed
Standardize the opening statement between readme and pypi readme
dagardner-nv Jul 24, 2026
fe5fe48
Merge branch 'main' of github.com:NVIDIA/NeMo-Fabric into david-docs-…
dagardner-nv Jul 24, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .agents/skills/review-doc-style/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ and NVIDIA NeMo Fabric repo conventions.
- Run `just docs` to regenerate and validate the API reference after changing a
source or generator.

## Documentation Links

- For links between files under `docs/`, use paths relative to the source file
and include the target file's `.mdx` extension. These links work in both Fern
builds and repository browsers.
- Do not use Fern site-root paths such as
`[NeMo Fabric overview](/nemo/fabric/about-nemo-fabric/overview)`.
- Use the repository-relative equivalent, such as
`[NeMo Fabric overview](../about-nemo-fabric/overview.mdx)`.

## Review Priorities

- Prioritize factual accuracy over copy polish
Expand Down Expand Up @@ -65,6 +75,8 @@ Treat these as blocking issues:
- User-facing naming is inconsistent with current repo terminology
- MDX top-of-file SPDX comments use HTML comment delimiters instead of
`{/* ... */}`
- Links between files under `docs/` use Fern site-root paths instead of
repository-relative `.mdx` paths
- NVIDIA is not capitalized correctly
- Code, commands, paths, or filenames are not formatted as inline code where needed

Expand All @@ -87,7 +99,8 @@ Flag these when they materially improve clarity or consistency:
- **Entry points**: Top-level docs changed wherever users would naturally look first.
- **Headings**: Technical docs use title case consistently.
- **Voice**: Prefer active voice, present tense, short sentences, and plain English.
- **Links**: Use descriptive anchor text, not bare URLs or weak labels.
- **Links**: Use descriptive anchor text, not bare URLs or weak labels. For links
within `docs/`, use repository-relative paths with the `.mdx` extension.
- **Formatting**: Commands, code elements, expressions, file names, and paths are monospace.
- **MDX headers**: Top-of-file MDX SPDX comments use `{/*` and `*/}` delimiters.
- **Procedures**: Steps are easy to scan, imperative, and split into smaller tasks when long.
Expand Down
1 change: 1 addition & 0 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ reviews:
- path: "{docs/**,README.md,AGENTS.md}"
instructions: |
Review documentation for technical accuracy against the current API, command correctness, and consistency with generated schemas.
For links between files under docs/, require paths relative to the source file with the target file's .mdx extension so they work in both Fern builds and repository browsers. Flag Fern site-root links such as [NeMo Fabric overview](/nemo/fabric/about-nemo-fabric/overview); use the repository-relative equivalent, such as [NeMo Fabric overview](../about-nemo-fabric/overview.mdx).
- path: "{*.md,**/*.md,**/*.mdx,**/*.ipynb}"
instructions: |
Enforce the product name in user-facing prose: use "NVIDIA NeMo Fabric" on first use and "NeMo Fabric" thereafter. Flag standalone capitalized "Fabric" when it refers to the product. Do not flag the lowercase `fabric` CLI command, package/import/crate names, code identifiers, API symbols, configuration keys, file paths, or unrelated generic uses of the word.
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ build/
/docs/node_modules/

examples/*/artifacts/
examples/harbor/*/runs/
tests/fixtures/*/artifacts/
integrations/harbor/demo/runs/
integrations/harbor/demo/task/environment/vendor/
Expand Down
5 changes: 4 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@ Key conventions for the two tiers:
and example URLs rather than a docs-site domain, so they keep working when
exported.
- **Supported consumer surface:** the consumer tier currently ships one skill,
`nemo-fabric-integrate`, for typed Python SDK integration.
`skills/integrations/consumer/nemo-fabric-integrate`, for typed Python SDK
integration. Future public harness adapter-authoring skills belong under
`skills/integrations/harness/`; repository-internal adapter maintenance stays
in `.agents/skills/`.

## Documentation And Contribution Workflow

Expand Down
53 changes: 31 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,6 @@ the development workflow, coding standards, and pull request process.
This section collects the setup steps needed before building, testing, or
contributing changes.

### Package Installation

NeMo Fabric is not currently available on PyPI. To consume the Python packages,
build wheels from a source checkout:

```bash
just wheels
uv pip install --find-links dist nemo-fabric
```

Adapters are distributed as optional extras. For example, install the Hermes Agent adapter with:

```bash
uv pip install --find-links dist "nemo-fabric[hermes]"
```

Refer to the [installation guide](docs/getting-started/install.mdx) for the
complete list of adapters and installation options.

### Source Development

Install these tools before you start:
Expand All @@ -54,8 +35,36 @@ uv sync --all-groups --all-extras
just no_uv=true build-all
```

Verify the checkout by running the test suites described in
[Testing Requirements](#testing-requirements).
In the above, replace `3.13` with the Python version you want to use for development.

Verify the checkout by running the test suites described in [Testing](#testing).

### Package Installation

To build Python packages (wheels) locally from a source checkout:

```bash
just wheels
```

The resulting wheel files are placed in the `dist/` directory. Install the
packages into a virtual environment with:

```bash
uv pip install --find-links ./dist "nemo-fabric[runtime]"
```

Adapters are distributed as optional extras. For example, install the Hermes
Agent adapter with:

```bash
uv pip install --find-links ./dist "nemo-fabric[hermes]"
```

Refer to the [installation guide](docs/getting-started/install.mdx) for the
complete list of adapters and installation options.



## Release Tagging

Expand Down Expand Up @@ -95,7 +104,7 @@ Use the naming conventions appropriate to each language: Rust and Python use
`snake_case` for functions and variables, Rust types use `PascalCase`, and
Python classes use `PascalCase`.

## Testing Requirements
## Testing

**Run tests for every language surface affected by your changes.** If a change
touches the Rust core or public schemas, run both the Rust and Python suites
Expand Down
Loading
Loading