Skip to content

Update identify-web-user.mdx #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Update identify-web-user.mdx #188

wants to merge 20 commits into from

Conversation

Atul-Butola
Copy link
Contributor

@Atul-Butola Atul-Butola commented Apr 2, 2025

@Atul-Butola Atul-Butola requested a review from a team as a code owner April 2, 2025 08:52
@Atul-Butola Atul-Butola marked this pull request as draft April 2, 2025 08:53
Copy link
Contributor

github-actions bot commented Apr 2, 2025

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

Copy link
Contributor

github-actions bot commented Apr 2, 2025

@@ -102,7 +102,7 @@ If you prefer a two-level structure, where users are directly associated with an
|`account_ref` |A unique reference for the account. |string |
|`display_name` | The name of the account that's shown on the widget. |string |
|`domains` |The domain names of the accounts that the users belongs to. |array |
| `phone_numbers` |The phone number associated with the account. |array |
|`phone_numbers` |The phone number associated with the account must be in E.164 format. |array |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
|`phone_numbers` |The phone number associated with the account must be in E.164 format. |array |
|`phone_numbers` |The phone number associated with the account in E.164 format. |array |

@Atul-Butola Atul-Butola marked this pull request as ready for review April 8, 2025 05:48
Copy link
Contributor

github-actions bot commented Apr 8, 2025

Copy link
Contributor

github-actions bot commented Apr 8, 2025

@Atul-Butola Atul-Butola changed the title **WIP** Update identify-web-user.mdx Update identify-web-user.mdx Apr 8, 2025
Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

@bc-devrev bc-devrev left a comment

Choose a reason for hiding this comment

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

The suggestions are mostly superficial but please address them before merging.


DevRev offers three ways to structure your customer's data:
1. **Single-level (Recommended for most B2C cases)**
- User
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure what this means.

### How resolution works

DevRev offers three ways to structure your customer's data:
1. **Single-level (Recommended for most B2C cases)**
Copy link
Contributor

Choose a reason for hiding this comment

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

This list would probably be better as a table with columns number of levels, use case, user relationship, and required information.

If you prefer a two-level structure, where users are directly associated with an account instead of a workspace, you can provide the `user_ref` and details along with the `account_ref` and details.
### API status codes and troubleshooting

| Status code| Description & Troubleshooting |
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be better to have troubleshooting at its own column.

Suggested change
| Status code| Description & Troubleshooting |
| Status code| Description | Troubleshooting |

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Ensure you copy your access token, as you will not be able to view it again.

Copy link
Contributor

Copy link
Contributor

@bc-devrev
Copy link
Contributor

@Atul-Butola please either complete this PR or close it.

@Atul-Butola
Copy link
Contributor Author

@sambhavjain9138 , are we good to go live? This is open from a long time, please confirm.

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.

3 participants