Add a Preferences page to the user documentation - #339
Open
pysnooLab wants to merge 2 commits into
Open
Conversation
Atomic CRM supports i18n, but the language switcher was only documented in the developers' customizing page, which users never read. Document the per-user preferences (avatar, name, email, language, password) in the users section, and cross-link the two pages.
erwanMarmelab
requested changes
Aug 25, 2026
|
|
||
| Click the "Edit" button, update the "First name", "Last name", and "Email" fields, then click "Save". | ||
|
|
||
| Your email address is also your login: once changed, sign in with the new address. It is also where Atomic CRM sends notifications and password reset emails. |
Contributor
There was a problem hiding this comment.
"sends notifications" emails -> no such feature exists.
|
|
||
| - The "Profile" section holds your avatar, first name, last name, and email. Tap a row to edit it; each change is saved as soon as you validate it. | ||
| - The "Preferences" section holds the language selector and a light/dark theme switch. | ||
| - The "Change password" button sits at the bottom of the page, next to "Log out". |
Contributor
There was a problem hiding this comment.
Suggested change
| - The "Change password" button sits at the bottom of the page, next to "Log out". | |
| - The "Change password" button sits at the bottom of the page, next to "Logout". |
Contributor
Author
There was a problem hiding this comment.
Label shown to user is "Log out" so no need to modify this one.
| On a mobile device, these preferences live in the Settings tab of the bottom navigation bar (see [Mobile App](../../users/mobile-app)): | ||
|
|
||
| - The "Profile" section holds your avatar, first name, last name, and email. Tap a row to edit it; each change is saved as soon as you validate it. | ||
| - The "Preferences" section holds the language selector and a light/dark theme switch. |
Contributor
There was a problem hiding this comment.
Suggestion:
WDYT about this suggestion ?
Suggested change
| - The "Preferences" section holds the language selector and a light/dark theme switch. | |
| - The "Preferences" section holds the language selector and a system/light/dark theme switch. |
Your text il clearer but this one is more complete. As you want...
| - The "Preferences" section holds the language selector and a light/dark theme switch. | ||
| - The "Change password" button sits at the bottom of the page, next to "Log out". | ||
|
|
||
| On desktop, the light/dark theme is switched with the sun/moon button in the top right corner of the application, next to your profile picture. |
Contributor
There was a problem hiding this comment.
same here (as you want)
Suggested change
| On desktop, the light/dark theme is switched with the sun/moon button in the top right corner of the application, next to your profile picture. | |
| On desktop, the system/light/dark theme is switched with the sun/moon button in the top right corner of the application, next to your profile picture. |
Atomic CRM sends no notification emails: the only outbound mails are Supabase Auth transactional ones (invitation, password recovery, email change confirmation). The theme switch offers system in addition to light and dark, on both mobile and desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Atomic CRM supports i18n, but it isn't discoverable. In the app you have to dig into the user preferences to find the language switcher, and in the documentation it is only mentioned in Customizing > Languages (i18n), a developer page users never open.
More generally, nothing in the user documentation explains the per-user preferences at all: avatar, name, email, language, password.
Solution
Add a Preferences page to the Users documentation, listed between "User Management" and "Application Settings":
The page links to the developer doc for adding a new language, and that section now links back to the user page, so the two are reachable from each other.
Includes 4 screenshots captured from the demo app.
How to test
Open http://localhost:4321/atomic-crm/doc/users/preferences/ and check that:
make doc-buildpasses (21 pages).