Skip to content

docs: maintenance on user search docs#1531

Open
hazel-nut wants to merge 5 commits into
mainfrom
docs/user-search
Open

docs: maintenance on user search docs#1531
hazel-nut wants to merge 5 commits into
mainfrom
docs/user-search

Conversation

@hazel-nut

@hazel-nut hazel-nut commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Description

consolidates user search docs into three articles:

  • search for specific users by id/email
  • list and search for users with query strings
  • query string syntax reference and examples

removes information duplicated from management api reference (e.g. on pagination).

Testing

best reviewed by looking over the three pages in the preview rather than looking at the diff in this PR.

already approved by the PM for search.

Checklist

  • I've read and followed CONTRIBUTING.md.
  • I've tested the site build for this change locally.
  • I've made appropriate docs updates for any code or config changes.
  • I've coordinated with the Product Docs and/or Docs Management team about non-trivial changes.

@hazel-nut
hazel-nut requested a review from a team as a code owner July 13, 2026 20:26
@hazel-nut
hazel-nut marked this pull request as draft July 13, 2026 20:26
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Status Count
🔍 Total 24
✅ Successful 6
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 18
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0
Full Github Actions output

Comment thread main/config/redirects.json Outdated
Comment thread main/docs/manage-users/user-search/list-and-search-users.mdx Outdated
Comment thread main/docs/manage-users/user-search/get-users-by-id-or-email.mdx Outdated
Comment thread main/docs/manage-users/user-search/user-search-query-syntax.mdx Outdated
Comment thread main/docs/manage-users/user-search/user-search-query-syntax.mdx Outdated
Comment thread main/docs/manage-users/user-search/user-search-query-syntax.mdx Outdated
@@ -1,22 +1,4 @@
---

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.

is there a need to keep this page?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

it has the auto-generated overview of child pages, so i think it serves as a nice landing page

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.

2 participants