fix: various docs updates, including hiding intake#455
Conversation
Signed-off-by: Matt Kornfield <[email protected]>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThe 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. ChangesFern public spec pipeline
Docs version and link updates
Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (18)
.github/workflows/fern-docs-preview-comment.yaml.gitignoredocs/AGENTS.mddocs/agents/plugins.mdxdocs/auth/authorization/managing-access.mdxdocs/auth/authorization/permissions-reference.mdxdocs/contributing/skills-spec.mdxdocs/customizer/tutorials/format-training-dataset.mdxdocs/evaluator/tutorials/index.mdxdocs/fern/README.mddocs/fern/generators.ymldocs/fern/package.jsondocs/fern/scripts/docs-watch.mjsdocs/fern/scripts/filter-public-openapi.mjsdocs/get-started/concepts/filtering.mdxdocs/requirements.mdxdocs/support-matrix.mdxservices/core/auth/scripts/auth-tools.py
💤 Files with no reviewable changes (2)
- docs/contributing/skills-spec.mdx
- docs/auth/authorization/permissions-reference.mdx
|
Signed-off-by: Matt Kornfield <[email protected]>
Signed-off-by: Matt Kornfield <[email protected]>
Summary by CodeRabbit