docs: sync docs with improvements done in Admin UI application#2883
Conversation
Signed-off-by: duttarnab <arnab.bdutta@gmail.com>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughDocumentation across multiple Admin UI pages and navigation is updated to match current application state: the introduction is rewritten with a structured frontend technology list and Agama Lab–based license activation model; license verification endpoints and sequence diagrams are updated from SCAN to Agama Lab; the ChangesAdmin UI Documentation Sync
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
mo-auto
added
area-documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/admin/admin-ui/configuration.md (1)
101-117: 🧹 Nitpick | 🔵 Trivial | ⚡ Quick winAdd trailing pipe to table rows for consistent formatting.
The table header (lines 101–102) uses leading and trailing pipes, but the new rows added at lines 106–117 appear to use inconsistent pipe formatting. For MkDocs/Markdown table consistency, all rows should use the same style. The markdownlint warning at line 112 flags a missing trailing pipe.
🔧 Example of consistent formatting
All table rows should match this pattern (matching the header format):
|licenseKey| License-key to access Admin UI | |licenseHardwareKey| Hardware key (org_id) to access license APIs |Each row should have a leading pipe before the first column and a trailing pipe after the last column, consistent with lines 101–102.
🤖 Prompt for 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. In `@docs/admin/admin-ui/configuration.md` around lines 101 - 117, Add trailing pipes to all table rows in the configuration attributes table (licenseConfig through oidcClient rows) to match the consistent formatting style of the header row. Each row should have a leading pipe before the first column and a trailing pipe after the last column, matching the pattern used in the header at lines 101-102.Source: Linters/SAST tools
🤖 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/admin/admin-ui/auth-server-interaction.md`:
- Line 18: The endpoint reference on line 18 of the auth-server-interaction.md
file uses an abbreviated path (/isActive) while other API endpoints in the
documentation use full paths (such as /v1/license/isConfigValid shown on line
17). To maintain consistency, replace the abbreviated endpoint reference
(/isActive) with its complete path (/v1/license/isActive) in the sentence
describing the License API call to Agama Lab.
In `@docs/admin/admin-ui/introduction.md`:
- Line 19: The compound adjective "user facing" in the sentence "This user
facing Frontend has been developed using the following:" should be hyphenated as
"user-facing" to properly modify the noun "Frontend". Locate this sentence and
change "user facing" to "user-facing" to follow correct English grammar rules
for compound adjectives.
- Line 80: The Helm Deployments link in the introduction.md file has an
incorrect relative path that resolves to the wrong directory. Update the link
path for "Helm Deployments" from ../install/helm-install/README.md to
../../install/helm-install/README.md to correctly reference the Helm
installation documentation at the same depth level as the VM installer link,
which uses the correct ../../install/ prefix.
---
Outside diff comments:
In `@docs/admin/admin-ui/configuration.md`:
- Around line 101-117: Add trailing pipes to all table rows in the configuration
attributes table (licenseConfig through oidcClient rows) to match the consistent
formatting style of the header row. Each row should have a leading pipe before
the first column and a trailing pipe after the last column, matching the pattern
used in the header at lines 101-102.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: db32eb69-0c72-42f6-bac3-e031e2736a04
⛔ Files ignored due to path filters (25)
docs/assets/admin-ui/admin-ui-add-user.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-left-nav-menu.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-logging.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-scope.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-ssa.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-update-user.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-user-changepassword.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-user-screen.pngis excluded by!**/*.pngdocs/assets/admin-ui/audit-log.pngis excluded by!**/*.pngdocs/assets/admin-ui/auth-server-configuration.pngis excluded by!**/*.pngdocs/assets/admin-ui/authn.pngis excluded by!**/*.pngdocs/assets/admin-ui/client.pngis excluded by!**/*.pngdocs/assets/admin-ui/dynamic-scope.pngis excluded by!**/*.pngdocs/assets/admin-ui/health.pngis excluded by!**/*.pngdocs/assets/admin-ui/jans-assets.pngis excluded by!**/*.pngdocs/assets/admin-ui/jwks.pngis excluded by!**/*.pngdocs/assets/admin-ui/license-details.pngis excluded by!**/*.pngdocs/assets/admin-ui/localization.pngis excluded by!**/*.pngdocs/assets/admin-ui/openid-scope.pngis excluded by!**/*.pngdocs/assets/admin-ui/role-permission.pngis excluded by!**/*.pngdocs/assets/admin-ui/sessions.pngis excluded by!**/*.pngdocs/assets/admin-ui/settings.pngis excluded by!**/*.pngdocs/assets/admin-ui/trial-license.pngis excluded by!**/*.pngdocs/assets/admin-ui/upload-license.pngis excluded by!**/*.pngdocs/assets/admin-ui/webhook-view.pngis excluded by!**/*.png
📒 Files selected for processing (5)
docs/admin/admin-ui/auth-server-interaction.mddocs/admin/admin-ui/auth-server-menu.mddocs/admin/admin-ui/configuration.mddocs/admin/admin-ui/home.mddocs/admin/admin-ui/introduction.md
Signed-off-by: duttarnab <arnab.bdutta@gmail.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/admin/admin-ui/home.md (1)
87-87:⚠️ Potential issue | 🟡 MinorClarify that "Admin UI Logging Level" is a client-side setting stored in browser localStorage.
Line 87 documents "Admin UI Logging Level," but this setting is intentionally absent from the
uiConfigschema indocs/admin/admin-ui/configuration.mdbecause it is stored client-side in browser localStorage (viasaveLogLevelandgetLogLevelinadmin-ui/app/utils/logLevel.ts), not in the Auth Server's persistence layer. Update home.md to clarify that this is a client-side preference that persists locally in the browser.🤖 Prompt for 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. In `@docs/admin/admin-ui/home.md` at line 87, The documentation for "Admin UI Logging Level" in home.md does not clarify that this is a client-side preference stored in browser localStorage rather than in the Auth Server's persistence layer. Update the description to explicitly state that this setting is a client-side preference that persists locally in the browser via localStorage (as implemented by the saveLogLevel and getLogLevel utility functions), distinguishing it from other uiConfig settings that are stored server-side.
🤖 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.
Outside diff comments:
In `@docs/admin/admin-ui/home.md`:
- Line 87: The documentation for "Admin UI Logging Level" in home.md does not
clarify that this is a client-side preference stored in browser localStorage
rather than in the Auth Server's persistence layer. Update the description to
explicitly state that this setting is a client-side preference that persists
locally in the browser via localStorage (as implemented by the saveLogLevel and
getLogLevel utility functions), distinguishing it from other uiConfig settings
that are stored server-side.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f01c0496-f512-45c8-bcf5-61a317bee273
⛔ Files ignored due to path filters (7)
docs/assets/admin-ui/admin-ui-custom-script-1.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-custom-script-2.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-custom-script.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-user-claims-1.pngis excluded by!**/*.pngdocs/assets/admin-ui/admin-ui-user-claims-2.pngis excluded by!**/*.pngdocs/assets/admin-ui/localization.pngis excluded by!**/*.pngdocs/assets/admin-ui/theme-selection.pngis excluded by!**/*.png
📒 Files selected for processing (6)
docs/admin/admin-ui/configuration.mddocs/admin/admin-ui/home.mddocs/admin/admin-ui/introduction.mddocs/admin/admin-ui/left-nav-menu.mddocs/admin/admin-ui/scripts.mdmkdocs.yml
💤 Files with no reviewable changes (3)
- mkdocs.yml
- docs/admin/admin-ui/left-nav-menu.md
- docs/admin/admin-ui/scripts.md
Signed-off-by: duttarnab <arnab.bdutta@gmail.com>
Signed-off-by: duttarnab <arnab.bdutta@gmail.com>
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
3 participants
closes #2882
Summary by CodeRabbit