Skip to content

fix: various docs updates, including hiding intake#455

Merged
mckornfield merged 3 commits into
mainfrom
docs-fixes-020/mck
Jun 25, 2026
Merged

fix: various docs updates, including hiding intake#455
mckornfield merged 3 commits into
mainfrom
docs-fixes-020/mck

Conversation

@mckornfield

@mckornfield mckornfield commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated API reference generation to use a public-only OpenAPI spec for Fern, keeping gated/private endpoints out of published docs.
    • Refreshed Fern documentation workflow guidance and examples, including API filtering updates (filesets-based examples) and multiple NeMo Platform 0.2.0 version/site-scope updates.
  • Bug Fixes
    • Removed outdated Intake API content from the permissions reference.
    • Corrected documentation anchor/link issues and updated an API scope example path.
  • Chores
    • Improved Fern docs preparation and watch/reload behavior for OpenAPI assets; added gitignore coverage for generated public specs.

@mckornfield
mckornfield requested review from a team as code owners June 25, 2026 03:23
@github-actions github-actions Bot added the fix label Jun 25, 2026
@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 6b73e1a7-31ad-4c7d-a269-a21229615760

📥 Commits

Reviewing files that changed from the base of the PR and between e9e7418 and 47fc5e8.

📒 Files selected for processing (2)
  • docs/auth/authorization/api-scopes.mdx
  • docs/customizer/tutorials/format-training-dataset.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/auth/authorization/api-scopes.mdx
  • docs/customizer/tutorials/format-training-dataset.mdx

📝 Walkthrough

Walkthrough

The PR adds a public Fern OpenAPI filter, wires Fern preview and watch flows to generate it, removes Intake API permissions from the generated reference, and updates several docs pages for version, scope, anchors, and examples.

Changes

Fern public spec pipeline

Layer / File(s) Summary
Public spec filtering script
docs/fern/scripts/filter-public-openapi.mjs
Reads openapi.yaml, removes /apis/intake/v2/ paths and related operations, prunes unreachable schemas, and writes openapi.public.yaml.
Fern tooling wiring
docs/fern/package.json, docs/fern/scripts/docs-watch.mjs, .github/workflows/fern-docs-preview-comment.yaml, docs/fern/generators.yml, docs/fern/README.md, docs/AGENTS.md, .gitignore
Adds prepare:openapi, runs the filter step before Fern checks, preview generation, and docs-watch startup, points Fern at openapi.public.yaml, and documents/ignores the generated file.
Permissions reference exclusion
services/core/auth/scripts/auth-tools.py, docs/auth/authorization/permissions-reference.mdx
Skips the intake permission area during permissions-reference generation and removes the Intake API table from the rendered page.

Docs version and link updates

Layer / File(s) Summary
Release scope text
docs/agents/plugins.mdx, docs/requirements.mdx, docs/support-matrix.mdx, docs/contributing/skills-spec.mdx
Updates 0.1.0 references to 0.2.0, revises local-install scope text, marks Windows and WSL out of support, and removes the draft status line.
Tutorial links and examples
docs/auth/authorization/managing-access.mdx, docs/customizer/tutorials/format-training-dataset.mdx, docs/evaluator/tutorials/index.mdx, docs/get-started/concepts/filtering.mdx
Updates linked anchors and rewrites filtering examples to use filesets queries and client.files.filesets.list(...) examples.

Possibly related PRs

Suggested labels

docs

Suggested reviewers

  • maxdubrinsky
  • gabwow
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 29.17% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the PR’s main scope: docs updates plus hiding the intake API permissions section.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-fixes-020/mck

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/fern/scripts/docs-watch.mjs`:
- Around line 55-70: The openapi filter only runs once at startup, so watcher
restarts can reuse a stale openapi.public.yaml. Move or reuse prepareOpenapi()
so it runs again on every watch() restart before spawning fern docs dev, and
make sure the restart path in docs-watch.mjs always re-invokes the existing
prepareOpenapi function when files under docs/fern/openapi/ or
scripts/filter-public-openapi.mjs change.

In `@services/core/auth/scripts/auth-tools.py`:
- Around line 1204-1205: The docs generation stats in generate_docs are using
the full registry even after DOCS_EXCLUDED_PERMISSION_AREAS filtering, so the
reported “areas” count is inconsistent with the generated output. Update
generate_docs to compute the printed metrics from the same filtered collection
used for docs generation, such as area_groups or an equivalent filtered
registry, and keep the area totals aligned with the displayed content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: a3376812-3599-40a4-a319-737a220f40d7

📥 Commits

Reviewing files that changed from the base of the PR and between b4473e8 and c87eecc.

📒 Files selected for processing (18)
  • .github/workflows/fern-docs-preview-comment.yaml
  • .gitignore
  • docs/AGENTS.md
  • docs/agents/plugins.mdx
  • docs/auth/authorization/managing-access.mdx
  • docs/auth/authorization/permissions-reference.mdx
  • docs/contributing/skills-spec.mdx
  • docs/customizer/tutorials/format-training-dataset.mdx
  • docs/evaluator/tutorials/index.mdx
  • docs/fern/README.md
  • docs/fern/generators.yml
  • docs/fern/package.json
  • docs/fern/scripts/docs-watch.mjs
  • docs/fern/scripts/filter-public-openapi.mjs
  • docs/get-started/concepts/filtering.mdx
  • docs/requirements.mdx
  • docs/support-matrix.mdx
  • services/core/auth/scripts/auth-tools.py
💤 Files with no reviewable changes (2)
  • docs/contributing/skills-spec.mdx
  • docs/auth/authorization/permissions-reference.mdx

Comment thread docs/fern/scripts/docs-watch.mjs
Comment thread services/core/auth/scripts/auth-tools.py Outdated
@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 20910/27478 76.1% 61.2%
Integration Tests 12108/26247 46.1% 19.5%

Signed-off-by: Matt Kornfield <[email protected]>
@svvarom
svvarom self-requested a review June 25, 2026 15:50

@svvarom svvarom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mckornfield
mckornfield added this pull request to the merge queue Jun 25, 2026
Comment thread docs/evaluator/tutorials/index.mdx
@mckornfield
mckornfield removed this pull request from the merge queue due to a manual request Jun 25, 2026
@mckornfield
mckornfield enabled auto-merge June 25, 2026 16:25
@mckornfield
mckornfield added this pull request to the merge queue Jun 25, 2026
Merged via the queue into main with commit fac052e Jun 25, 2026
54 of 55 checks passed
@mckornfield
mckornfield deleted the docs-fixes-020/mck branch June 25, 2026 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants