Enhance Preferences Roles UX
Open
Nobody has claimed this yet.
documentation
enhancement
Preferences
- Dominant language
- JavaScript
- Stars
- 106
- Forks
- 52
- Avg merge
- 13h 35m
- Merged PRs (30d)
- 10
Description
Based on comments on https://github.com/solid/userguide/issues/17.
User Story
As a Data Browser user, I want to clearly understand the use of Roles within the Data Browser and how to select them, so I can access advanced Data Browser functionality.
Acceptance Criteria
- The Roles section of the Preferences page displays:
a. A short description about Roles and their use within the Data Browser.
b. A tip on how to select multiple roles. - The Userguide is updated to reflect the enhancement.
Dev Notes
- Use
fieldsetto group the roles with legend "Roles". - Potentially use
input=checkbox+label=for(instead ofoption) per role. Easy to select a role at a time, and for multiple role selections, it doesn't require key or click combinations. - Reuse text from
userguide#rolesfor the short description of a role either after eachlabelor have atitle(for tooltip) or some other indicator to help find out about the capabilities.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Preferences page's Roles section and the Userguide's roles content referenced in the issue. Review the existing role-selection UI and related guidance before making changes. Done means the Roles section has a description, multi-selection tip, and the Userguide reflects the enhancement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100