Skip to content

[docs] Organization docs for Access & Governance - #68

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/organisations-governance-a700b4d38c3c7e78
Draft

[docs] Organization docs for Access & Governance#68
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/organisations-governance-a700b4d38c3c7e78

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Ezhuthachan

Closes the request in #63 (/document Access & Governance/Organisations Governance). Doc types were omitted, so all three layers were written for the organization primitive in the access-governance domain.

Added

  • flows/access-governance/_category_.json
  • flows/access-governance/create-an-organization.mdx
  • flows/access-governance/add-a-user-to-an-organization.mdx
  • flows/access-governance/change-a-user-role-in-an-organization.mdx

Flow tasks were discovered from care_fe, and are ordered the way a user meets them: create first, then membership, then role changes and removal. The flow sidebar is a manual list, so a new Access & Governance flow category was added to both sidebar files.

Rewritten

  • concepts/access-governance/organization.mdx — replaced whole file. The old page used non-template headings ("What it represents", "Organization types", "How the tree works", "Membership, roles & responsibility", "Permissions") and printed raw code slugs such as can_view_organization, org_type, team, govt and role in a user-facing page. It now follows the concept template (Definition / Key Attributes / Status / Related), uses the labels a user sees, and links the FHIR Organization page without narrating the mapping. The permission table moved to the reference layer, where slugs belong.
  • references/access-governance/organization.mdx — kept the model, spec and save-behaviour sections, which verify correctly against the source. Rewrote the intro to the reference form, removed the FHIR-alignment narration, and added a new ## Viewsets & authorization section covering OrganizationViewSet, OrganizationUsersViewSet, the per-action checks and the permission-to-role table.

Versions

Authored in version-3.0 and mirrored byte-identical to version-3.1, including the new _category_.json. Both sidebar files were updated.

Traced to

  • care/emr/models/organization.py
  • care/emr/resources/organization/spec.py, organization_user_spec.py
  • care/emr/api/viewsets/organization.py
  • care/security/permissions/organization.py, care/security/authorization/organization.py, care/security/roles/role.py
  • care_fe/src/Routers/routes/OrganizationRoutes.tsx, adminRoutes.tsx
  • care_fe/src/components/ui/sidebar/admin-nav.tsx
  • care_fe/src/pages/Admin/organizations/ (AdminOrganizationList, AdminOrganizationView, components/AdminOrganizationFormSheet)
  • care_fe/src/pages/Organization/ (OrganizationUsers, OrganizationLayout, components/AddUserSheet, LinkUserSheet, EditUserRoleSheet)
  • care_fe/public/locale/en.json for every user-visible label

Left out

  • The default value of ORGANIZATION_MAX_DEPTH is not stated. The docs say only that a deployment sets a maximum depth.
  • No keyboard shortcut is mentioned. care_fe/src/config/keyboardShortcuts.json defines none for these actions.
  • The connected-role-organization management screen is not documented as a flow. It is a narrow instance-administrator task, and the request did not name it.

Validation

Corruption scan returns nothing. npm run build is [SUCCESS] for both en and ml, exit code 0.

Generated by Ezhuthachan for #63 · opus50 · 467.6 AIC · ⌖ 12.8 AIC · ⊞ 14.4K ·
Comment /document to run again

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Aug 10, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 10, 2026

Copy link
Copy Markdown

Deploying coredocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0129afd
Status: ✅  Deploy successful!
Preview URL: https://253dda5b.coredocs.pages.dev
Branch Preview URL: https://docs-organisations-governanc.coredocs.pages.dev

View logs

@github-actions github-actions Bot mentioned this pull request Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants