Skip to content

docs(accounts): enhance Accounts_SearchFields setting documentation#40945

Open
rish106-hub wants to merge 1 commit into
RocketChat:developfrom
rish106-hub:fix/issue-17203-accounts-search-fields-docs
Open

docs(accounts): enhance Accounts_SearchFields setting documentation#40945
rish106-hub wants to merge 1 commit into
RocketChat:developfrom
rish106-hub:fix/issue-17203-accounts-search-fields-docs

Conversation

@rish106-hub

@rish106-hub rish106-hub commented Jun 14, 2026

Copy link
Copy Markdown

Proposed changes

Added descriptive label and help text to Accounts_SearchFields setting explaining available search fields with examples including nested fields like emails.address and custom field references.

Issue(s)

Closes #17203

Steps to test or reproduce

  1. Go to Administration → Accounts → Settings
  2. Find "Fields to Consider in Search"
  3. Hover over the setting → help text displays examples of valid searchable fields
  4. Examples shown: username, name, bio, nickname, emails.address, status, statusText, language, customFields.fieldName

Review in cubic

Summary by CodeRabbit

  • Documentation

    • Enhanced documentation for account search field settings with improved help text describing supported searchable fields, including built-in and custom field examples.
  • Localization

    • Added English localization support for account search field configuration descriptions.

Added descriptive label and help text explaining available search fields with examples including nested fields like emails.address and custom field references.

Closes RocketChat#17203
@rish106-hub rish106-hub requested a review from a team as a code owner June 14, 2026 06:55
@dionisio-bot

dionisio-bot Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Looks like this PR is not ready to merge, because of the following issues:

  • This PR is missing the 'stat: QA assured' label
  • This PR is missing the required milestone or project

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

@changeset-bot

changeset-bot Bot commented Jun 14, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: e3a1a09

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@rocket.chat/meteor Patch
@rocket.chat/core-typings Patch
@rocket.chat/rest-typings Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 14, 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b284953b-2c76-4f7a-806c-e7956310b315

📥 Commits

Reviewing files that changed from the base of the PR and between a080c80 and e3a1a09.

📒 Files selected for processing (3)
  • .changeset/fix-accounts-search-fields-documentation.md
  • apps/meteor/server/settings/accounts.ts
  • packages/i18n/src/locales/en.i18n.json
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: cubic · AI code reviewer
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{ts,tsx,js}

📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)

**/*.{ts,tsx,js}: Write concise, technical TypeScript/JavaScript with accurate typing in Playwright tests
Avoid code comments in the implementation

Files:

  • apps/meteor/server/settings/accounts.ts
🧠 Learnings (4)
📚 Learning: 2026-03-16T21:50:37.589Z
Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39676
File: .changeset/migrate-users-register-openapi.md:3-3
Timestamp: 2026-03-16T21:50:37.589Z
Learning: For changes related to OpenAPI migrations in Rocket.Chat/OpenAPI, when removing endpoint types and validators from rocket.chat/rest-typings (e.g., UserRegisterParamsPOST, /v1/users.register) document this as a minor changeset (not breaking) per RocketChat/Rocket.Chat-Open-API#150 Rule 7. Note that the endpoint type is re-exposed via a module augmentation .d.ts in the consuming package (e.g., packages/web-ui-registration/src/users-register.d.ts). In reviews, ensure the changeset clearly states: this is a non-breaking change, the major version should not be bumped, and the changeset reflects a minor version bump. Do not treat this as a breaking change during OpenAPI migrations.

Applied to files:

  • .changeset/fix-accounts-search-fields-documentation.md
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In the Rocket.Chat repository, do not reference Biome lint rules in code review feedback. Biome is not used even if biome.json exists; only reference Biome rules if there is explicit, project-wide usage documented. For TypeScript files, review lint implications without Biome guidance unless the project enables Biome rules.

Applied to files:

  • apps/meteor/server/settings/accounts.ts
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In this repository (RocketChat/Rocket.Chat), Biome lint rules are not used even if a biome.json exists. When reviewing TypeScript files (e.g., packages/ui-voip/src/providers/useMediaSession.ts), ensure lint suggestions do not reference Biome-specific rules. Rely on general ESLint/TypeScript lint rules and project conventions instead.

Applied to files:

  • apps/meteor/server/settings/accounts.ts
📚 Learning: 2026-05-06T12:21:44.083Z
Learnt from: juliajforesti
Repo: RocketChat/Rocket.Chat PR: 40256
File: apps/meteor/client/components/CreateDiscussion/CreateDiscussion.tsx:121-149
Timestamp: 2026-05-06T12:21:44.083Z
Learning: Field wrappers in rocket.chat/fuselage-forms (Field, FieldLabel, FieldRow, FieldError, FieldHint) auto-create htmlFor/id associations, aria-describedby, and role="alert" for errors. Do not manually set htmlFor, id, aria-describedby, or role attributes when using these wrappers. This automatic wiring does not apply to plain rocket.chat/fuselage components, which require explicit ID wiring per the accessibility docs. In code reviews, prefer using fuselage-forms wrappers for form fields and verify there is no unnecessary manual ID/aria wiring in files that use these wrappers. If a component uses plain fuselage components, ensure proper id wiring as per docs.

Applied to files:

  • apps/meteor/server/settings/accounts.ts
🔇 Additional comments (3)
apps/meteor/server/settings/accounts.ts (1)

267-271: LGTM!

packages/i18n/src/locales/en.i18n.json (1)

416-417: LGTM!

.changeset/fix-accounts-search-fields-documentation.md (1)

1-9: LGTM!


Walkthrough

Adds a description to the Accounts_SearchFields administration setting. The setting definition in accounts.ts gains an i18nDescription key, the English locale file gains the corresponding Accounts_SearchFields_Description translation string with field examples, and a patch-level changeset entry is added.

Changes

Accounts_SearchFields Setting Description

Layer / File(s) Summary
Setting description key and translation
apps/meteor/server/settings/accounts.ts, packages/i18n/src/locales/en.i18n.json, .changeset/fix-accounts-search-fields-documentation.md
Accounts_SearchFields setting options gains an i18nDescription field; the English locale adds Accounts_SearchFields_Description listing comma-separated searchable user field examples including emails.address and customFields.fieldName; a patch changeset entry documents the change.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

type: chore

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: enhancing documentation for the Accounts_SearchFields setting with clearer descriptions and examples.
Linked Issues check ✅ Passed The PR fulfills issue #17203 by documenting the Accounts_SearchFields setting with clear examples including the non-obvious emails.address syntax and a comprehensive list of available searchable fields.
Out of Scope Changes check ✅ Passed All changes are focused on documentation and localization for the Accounts_SearchFields setting, directly addressing the issue requirements with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • ISSUE-17203: Request failed with status code 401

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.

@cubic-dev-ai cubic-dev-ai 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.

No issues found across 3 files

Re-trigger cubic

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation on UI option for Accounts_SearchFields should be enhanced

1 participant