Skip to content

Commit fac052e

Browse files
authored
fix: various docs updates, including hiding intake (#455)
* fix: various docs updates, including hiding intake Signed-off-by: Matt Kornfield <mkornfield@nvidia.com> * chore: address cr Signed-off-by: Matt Kornfield <mkornfield@nvidia.com> * chore: remove tool workflow ref, update auditor endpoint Signed-off-by: Matt Kornfield <mkornfield@nvidia.com> --------- Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
1 parent d2440dc commit fac052e

19 files changed

Lines changed: 308 additions & 71 deletions

File tree

.github/workflows/fern-docs-preview-comment.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ jobs:
6262
HEAD_REF: ${{ steps.metadata.outputs.head_ref }}
6363
working-directory: ./docs/fern
6464
run: |
65+
node scripts/filter-public-openapi.mjs
6566
OUTPUT=$(npx -y fern-api@latest generate --docs --preview --id "$HEAD_REF" 2>&1)
6667
echo "$OUTPUT"
6768
URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()')

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,6 @@ docker/logs/*
143143
# Linting artifact
144144
python-sdk-lint/
145145
site/
146+
147+
# Generated Fern-only public API reference spec
148+
docs/fern/openapi/openapi.public.yaml

docs/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ These are generated; edit the source and regenerate:
3939

4040
## API reference
4141

42-
The REST API reference is rendered natively by Fern from the OpenAPI spec — `docs/fern/generators.yml` points at `docs/fern/openapi/openapi.yaml` (a symlink to the generated repo-root `openapi/openapi.yaml`), surfaced by the `- api: API Reference` nav node. No `<swagger-ui>` embed.
42+
The REST API reference is rendered natively by Fern from a docs-only filtered OpenAPI spec. `docs/fern/openapi/openapi.yaml` is a symlink to the generated repo-root `openapi/openapi.yaml`, and `npm run prepare:openapi` writes `docs/fern/openapi/openapi.public.yaml` for Fern. `docs/fern/generators.yml` must point at the public filtered spec, surfaced by the `- api: API Reference` nav node. No `<swagger-ui>` embed.

docs/agents/plugins.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: ""
44
---
55
<a id="agents-plugins"></a>
66

7-
NeMo Platform 0.1.0 is extended through Python plugins and
7+
NeMo Platform 0.2.0 is extended through Python plugins and
88
coding-agent skills. Plugins add runtime capabilities to the local platform.
99
Skills teach your coding agent how to operate those capabilities on your behalf.
1010

@@ -103,5 +103,5 @@ Plugin authors use the `nemo-platform-plugin` package. A minimal plugin declares
103103
points in `pyproject.toml`, implements the matching class, and restarts
104104
`nemo services run` so the local platform discovers it.
105105

106-
Keep plugins local-first for OSS 0.1.0: avoid requiring a cluster,
106+
Keep plugins local-first for OSS 0.2.0: avoid requiring a cluster,
107107
container runtime, or external control plane for the documented launch path.

docs/auth/authorization/api-scopes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Each API has a read and write scope. A token with an API-specific scope can only
2525

2626
| API | Read Scope | Write Scope | Endpoints |
2727
|------|-----------|-------------|------|
28-
| Audit | `audit:read` | `audit:write` | `/apis/audit/` |
28+
| Audit | `audit:read` | `audit:write` | `/apis/auditor/` |
2929
| Auth | `auth:read` | `auth:write` | `/apis/auth/` |
3030
| Data Designer | `data-designer:read` | `data-designer:write` | `/apis/data-designer/` |
3131
| Entities | `entities:read` | `entities:write` | `/apis/entities/` (internal — see note) |

docs/auth/authorization/managing-access.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Add users to workspaces, assign roles, and control who can access your resources
66

77
<Note>
88

9-
The SDK examples on this page use `NeMoPlatform()` with no arguments so that the client reads your active CLI context (set by `nemo auth login`). That is the right pattern for authorization workflows: you act as your logged-in identity and pass the workspace explicitly in each API call. For the standard local initialization pattern, see [CLI and SDK initialization](/documentation/get-started#setup-init).
9+
The SDK examples on this page use `NeMoPlatform()` with no arguments so that the client reads your active CLI context (set by `nemo auth login`). That is the right pattern for authorization workflows: you act as your logged-in identity and pass the workspace explicitly in each API call. For the standard local initialization pattern, see [CLI and SDK initialization](/documentation/get-started#nemo-setup).
1010

1111
</Note>
1212
## Creating Workspaces

docs/auth/authorization/permissions-reference.mdx

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -58,22 +58,6 @@ PlatformAdmin is omitted — it bypasses permission checks entirely at the polic
5858
| <code>inference.virtual-models.(read &#124; list)</code> | Read, list inference virtual-models ||||
5959
| <code>inference.virtual-models.(create &#124; update &#124; delete)</code> | Create, update, delete inference virtual-models | |||
6060

61-
## Intake API
62-
63-
| Permission | Description | Viewer | Editor | Admin |
64-
|------------|-------------|:------:|:------:|:-----:|
65-
| <code>intake.annotations.(read &#124; list)</code> | Read, list intake annotations ||||
66-
| <code>intake.annotations.(create &#124; delete)</code> | Create, delete intake annotations | |||
67-
| <code>intake.evaluator-results.(read &#124; list)</code> | Read, list intake evaluator-results ||||
68-
| `intake.evaluator-results.create` | Create intake evaluator results | |||
69-
| `intake.experiment-groups.read` | Read intake experiment groups ||||
70-
| <code>intake.experiment-groups.(create &#124; update &#124; delete)</code> | Create, update, delete intake experiment-groups | |||
71-
| `intake.experiments.read` | Read intake experiments ||||
72-
| <code>intake.experiments.(create &#124; update &#124; delete)</code> | Create, update, delete intake experiments | |||
73-
| `intake.ingest.create` | Ingest traces into intake | |||
74-
| <code>intake.spans.(read &#124; list)</code> | Read, list intake spans ||||
75-
| `intake.traces.read` | Read intake traces ||||
76-
7761
## Jobs API
7862

7963
| Permission | Description | Viewer | Editor | Admin |

docs/contributing/skills-spec.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "NeMo Platform Skills Spec"
33
description: ""
44
---
5-
**Status:** Draft.
65

76
This document defines the conventions for skills shipped with NeMo Platform: how they're structured, what their frontmatter must contain, how they get tested, and where they live in the repo.
87

docs/customizer/tutorials/format-training-dataset.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ For illustrative purposes only, we show an example entry as multi-line JSON.
236236
</Accordion>
237237
##### Shared Tools
238238

239-
When your dataset uses the same set of tools across all examples, include the shared tool definitions in **each training row** (Automodel jobs do not accept a separate `dataset_parameters` block). See the [Tool Calling tutorial](/documentation/example-applications/tool-calling) for a full workflow.
239+
When your dataset uses the same set of tools across all examples, include the shared tool definitions in **each training row** (Automodel jobs do not accept a separate `dataset_parameters` block).
240240

241241
```python
242242
import os

docs/evaluator/tutorials/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ Learn how to write a domain-specific Python metric, test it locally, and run it
3232

3333
## How It Works
3434

35-
For the conceptual overview of how Evaluator separates definition (library) from execution (platform), see [About Evaluating → How It Works](/documentation/evaluate-models#how-it-works-library-platform). For runnable SDK examples, see [SDK Resources](/documentation/evaluate-models/sdk-resources).
35+
For the conceptual overview of how Evaluator separates definition (library) from execution (platform), see [About Evaluating → How It Works](/documentation/evaluate-models#how-it-works-library--platform). For runnable SDK examples, see [SDK Resources](/documentation/evaluate-models/sdk-resources).

0 commit comments

Comments
 (0)