Docs/user permissions documentation (Resolving Issue#88)#108
Open
praniketkw wants to merge 2 commits intoSSDALab:mainfrom
Open
Docs/user permissions documentation (Resolving Issue#88)#108praniketkw wants to merge 2 commits intoSSDALab:mainfrom
praniketkw wants to merge 2 commits intoSSDALab:mainfrom
Conversation
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
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.
📄 Description
This PR adds comprehensive documentation for the user permissions system as requested in issue #88.
While issue #88 was previously addressed with a Google Spreadsheet, this PR provides in-repository documentation that is easier to maintain and more comprehensive
The document covers the four user roles (Volunteer, Manager, Admin, Super Admin) and their specific permissions. Each role's access to users and surveys is detailed with the exact conditions that apply. I've also included the user lifecycle, approval process, and practical examples showing how permissions are evaluated in real scenarios.
All permissions were verified against the actual implementation in the codebase to ensure accuracy.
✅ Checklist
🔗 Related Issues
Resolves #88
💡 Type of change
🧪 How to test
server/src/permissions/abilityBuilder.ts📝 Notes to reviewers
I went through the CASL permission implementation carefully to make sure this documentation matches the actual code behavior. Each permission was verified against the abilityBuilder.ts file. I've included real-world examples to help users understand how