Skip to content

docs(user-guide): add auditor role documentation - #380

Open
mykolanehrych wants to merge 1 commit into
codemie-ai:mainfrom
mykolanehrych:docs/EPMCDME-10930-auditor-role
Open

docs(user-guide): add auditor role documentation#380
mykolanehrych wants to merge 1 commit into
codemie-ai:mainfrom
mykolanehrych:docs/EPMCDME-10930-auditor-role

Conversation

@mykolanehrych

Copy link
Copy Markdown
Contributor

Summary

Documents the new is_auditor boolean flag introduced in EPMCDME-10930. Covers the full feature across both admin and user-facing documentation.

Changes

  • docs/admin/security/roles-rbac.md — added Auditor column to capability matrix, new "View all users/projects/budgets" row, updated role hierarchy diagram, and new ## Auditor Flag section with access table, combination rules, and assignment steps
  • docs/user-guide/project-user-management/users.md — updated access admonition; added Platform Roles block description and ### Platform Roles assignment section with screenshots (toggle on/disabled+tooltip/auditor read-only view)
  • docs/user-guide/project-user-management/projects.md — added Auditor read-only visibility note and screenshot to intro
  • docs/user-guide/analytics/index.md — added ### Auditor access subsection; updated Personal Spending and Leaderboard blurbs
  • docs/user-guide/budget-management/index.md — updated access text and table (Auditor column added, redirect note)
  • faq/ — two new FAQ entries: assigning the Auditor flag, and what Auditors can see and do

Testing

  • Tested locally with npm start
  • All pages render correctly
  • Images display properly
  • Internal links work
  • Sidebar navigation works

Quality Checks

  • npm run check passes (typecheck + lint + commitlint)
  • npm run build passes — no broken links
  • No MDX compilation errors
  • No raw angle brackets
  • Sidebar references document IDs (not filenames)
  • Images stored locally next to content (not in static/img/)
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

Pre-commit secrets scan skipped locally (ghcr.io unreachable from Rancher Desktop at commit time; Gitleaks image has since been pulled). CI pipeline runs its own Gitleaks scan before merge.

@mykolanehrych
mykolanehrych force-pushed the docs/EPMCDME-10930-auditor-role branch from e7bd02d to 3d0e24f Compare September 1, 2026 10:56
@mykolanehrych mykolanehrych changed the title docs(user-guide): add auditor role documentation (EPMCDME-10930) docs(user-guide): add auditor role documentation Sep 1, 2026
Document the new is_auditor boolean flag: capability matrix update in
roles-rbac.md, read-only access notes in Analytics/Projects/Users/Budgets,
Platform Roles assignment steps in Users Management, and two FAQ entries.

Refs: EPMCDME-10930
@mykolanehrych
mykolanehrych force-pushed the docs/EPMCDME-10930-auditor-role branch from 3d0e24f to 8075dc7 Compare September 1, 2026 11:02
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.

1 participant