docs(auth): restructure auth docs into Fern navigation and fix rendering issues#368
Merged
Conversation
Contributor
|
🌿 Preview your docs: https://nvidia-preview-auth-docs-rsadler.docs.buildwithfern.com/nemo-platform |
711a4be to
1f61a90
Compare
Contributor
|
|
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 (14)
✅ Files skipped from review due to trivial changes (9)
🚧 Files skipped from review as they are similar to previous changes (4)
📝 WalkthroughWalkthroughAdds a ChangesDocs Live-Reload Tooling
Access Control Docs Restructure
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 docstrings
🧪 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 80-88: The shutdown function kills the fern subprocess but does
not explicitly exit the process with the proper signal exit code, causing the
process to exit with code 0 instead. After calling fern.kill(signal) in the
shutdown function, add a process.exit() call that exits with the appropriate
signal exit code. The exit code for signal termination should be calculated as
128 plus the signal number (for example, SIGTERM is signal 15, so exit code
should be 143).
- Around line 46-53: The shouldIgnore function currently returns true when
relativePath is falsy or missing, causing fs.watch events without filenames to
be silently ignored. Remove the early return check that tests for missing
filename (the `if (!relativePath) { return true; }` block), so that events
without filename information are not ignored and will instead trigger reloads to
ensure no changes are missed.
🪄 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: 80ce2055-6aa2-4faf-a904-31fd44930c4c
📒 Files selected for processing (12)
Makefiledocs/auth/authorization/index.mdxdocs/auth/authorization/permissions-reference.mdxdocs/auth/authorization/roles-and-permissions.mdxdocs/auth/concepts.mdxdocs/auth/deployment/configuration.mdxdocs/auth/security-model.mdxdocs/customizer/tutorials/index.mdxdocs/fern/package.jsondocs/fern/scripts/docs-watch.mjsdocs/fern/versions/latest.ymlservices/core/auth/scripts/auth-tools.py
d663bc8 to
7de3947
Compare
7de3947 to
75efe7e
Compare
mckornfield
approved these changes
Jun 17, 2026
75efe7e to
14ae8ad
Compare
…ing issues Add the Access Control section to the Fern docs navigation (latest.yml), covering authentication, authorization, deployment, and security model pages. Fix permissions-reference table rendering by replacing escaped pipe characters (`\\|`) with HTML entities (`|`) and `<code>` tags so permission patterns display correctly in MDX. Update cross-document links from relative `.md` paths to absolute Fern URL paths. Improve roles-and-permissions with a Mermaid flowchart for the role hierarchy. Refactor security-model and concepts pages for clarity and accuracy. Add docs-watch.mjs, a file-system watcher that triggers Fern live-reload when any file outside `docs/fern/` changes, and wire it up as `make docs-watch`. Extend auth-tools.py with a `generate-docs` command that regenerates the permissions reference from the auth configuration. Signed-off-by: Ryan Sadler <267728323+ironcommit@users.noreply.github.com>
14ae8ad to
8c97ef3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add the Access Control section to the Fern docs navigation (latest.yml), covering authentication, authorization, deployment, and security model pages.
Fix permissions-reference table rendering by replacing escaped pipe characters (
\\|) with HTML entities (|) and<code>tags so permission patterns display correctly in MDX. Update cross-document links from relative.mdpaths to absolute Fern URL paths.Improve roles-and-permissions with a Mermaid flowchart for the role hierarchy. Refactor security-model and concepts pages for clarity and accuracy.
Add docs-watch.mjs, a file-system watcher that triggers Fern live-reload when any file outside
docs/fern/changes, and wire it up asmake docs-watch.Extend auth-tools.py with a
generate-docscommand that regenerates the permissions reference from the auth configuration.Summary by CodeRabbit
make docs-watchfor repo-widedocs/**changes to automatically trigger Fern docs reloads.watchscript) to enable smoother local iteration outsidedocs/fern/.