Add detail on roles in README
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 7
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 28
Description
README should at least explain :
* how to write regex for the role matching (admin is a complete match, reader and writer is a regex, how is the domain retrieved ?)
* where the information is taken (access token ?) so that the user can configure its OIDC provider
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with README and trace the existing role-matching and OIDC/access-token configuration references in the project. Document how exact and regex role matches work, how the domain is retrieved, and where role information comes from so users can configure their OIDC provider; done means these behaviors are explained in the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- authentication, authorization, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100