Skip to content

Conversation

@PasinduYeshan
Copy link
Contributor

@PasinduYeshan PasinduYeshan commented Nov 13, 2025

Purpose

$subject

image image

Related Issues

Related PRs

Test environment

Security checks

Summary by CodeRabbit

  • Documentation
    • Enhanced guidance on managing attributes in the user store with detailed explanations of attribute value storage behavior and optimization through Attribute Mappings.
    • Added warnings about potential accessibility impacts when modifying attribute storage locations between user store and internal storage.

@coderabbitai
Copy link

coderabbitai bot commented Nov 13, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • en/asgardeo/docs/assets/img/guides/organization/attributes/configure-attribute-excluded-user-store.png is excluded by !**/*.png

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation update expanding the attribute management guide with a new "Manage in User Store" subsection that replaces a single-line instruction with comprehensive explanations of attribute storage behavior, visual aids, and a warning about potential accessibility issues when changing storage locations.

Changes

Cohort / File(s) Summary
Documentation expansion
en/includes/guides/users/attributes/manage-attributes.md
Replaces single-line instruction with multi-paragraph "Manage in User Store" subsection; adds explanatory text describing when attribute values are stored in user store vs. internally, refining behavior via Attribute Mappings, and a danger warning about accessibility when changing storage location; preserves subsequent steps.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Review focuses on documentation clarity, technical accuracy of attribute storage explanations, appropriateness of warning messaging, and proper formatting/visual presentation

Suggested reviewers

  • himeshsiriwardana

Poem

🐰 A tale of attributes stored near and far,
Where user stores shine brighter than a star,
We've penned the guidance, clear and bright,
With warnings that glow in the gentle light,
Documentation hops forward with delight! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete; it lacks substantive detail under 'Purpose' (shows only '$subject'), omits Test environment and Related PRs sections, and all security checks remain unchecked. Replace '$subject' with a clear description of the documentation changes, fill in Test environment details, and verify or complete security checklist items.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change—updating documentation related to 'Managed In User Store' functionality, which aligns with the file changes in the raw summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

❤️ Share

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bb37e6d and cb6a5c7.

⛔ Files ignored due to path filters (4)
  • en/asgardeo/docs/assets/img/guides/organization/attributes/configure-attribute-exclude-user-store.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/organization/attributes/configure-attribute-managed-in-user-store.png is excluded by !**/*.png
  • en/identity-server/next/docs/assets/img/guides/organization/attributes/configure-attribute-excluded-user-store.png is excluded by !**/*.png
  • en/identity-server/next/docs/assets/img/guides/organization/attributes/configure-attribute-managed-in-user-store.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • en/includes/guides/users/attributes/manage-attributes.md (1 hunks)
🔇 Additional comments (1)
en/includes/guides/users/attributes/manage-attributes.md (1)

380-403: Well-structured new section with comprehensive guidance.

The new "Manage in User Store" section is clear, well-organized, and appropriately detailed. The explanation of checked/unchecked behavior, integration with Attribute Mappings, and the accessibility warning are all valuable additions. The visual aids should help users understand the selective management capability.

Please verify that the referenced images exist at the specified paths:

  • {{base_path}}/assets/img/guides/organization/attributes/configure-attribute-managed-in-user-store.png (line 384)
  • {{base_path}}/assets/img/guides/organization/attributes/configure-attribute-excluded-user-store.png (line 393)

updating these attributes may not work as expected.


8. Under **Attribute Configurations**, use the table to configure how attributes are handled for each entity.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Fix duplicate step numbering.

Both the "Attribute Configurations" section (line 404) and the "Attribute Mappings" section (line 444) are numbered as step 8. The Attribute Mappings section should be numbered as step 9.

Apply this diff to fix the step numbering:

- 8. Go to the **Attribute Mappings** tab and enter the attribute from each user store that you need to map.
+ 9. Go to the **Attribute Mappings** tab and enter the attribute from each user store that you need to map.

Also applies to: 444-444

🤖 Prompt for AI Agents
In en/includes/guides/users/attributes/manage-attributes.md around line 404 (and
also at line 444), there's duplicate step numbering: the "Attribute
Configurations" section is step 8 and the "Attribute Mappings" section is also
labeled 8; change the numbering on the "Attribute Mappings" section at line 444
from "8." to "9." so the steps are sequential and unique.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant