Skip to content

docs: document the organizational structure - #552

Open
abdulrafey1 wants to merge 1 commit into
rafey/feat/org-tree-apifrom
rafey/docs/org-tree
Open

docs: document the organizational structure#552
abdulrafey1 wants to merge 1 commit into
rafey/feat/org-tree-apifrom
rafey/docs/org-tree

Conversation

@abdulrafey1

@abdulrafey1 abdulrafey1 commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Closes: Organizational structure has no representation

Part 3 of 3 stacked PRs — stacked on #550 (management surface). Merging this one closes #548.

What

Documents the organizational structure so the permissions guide and README describe the shipped behaviour.

Changes

  • docs: "Organizational structure" section in docs/guides/permissions.md — the two tables and their HR-truth role, the inert invariant (no can() path reads the tree) and why it exists anyway (rule-driven group membership will reference it), the engine-maintained path encoding (/1/7/42/), the management surface (REST /api/v1/organization/units incl. "parent_id": null = move to root; CLI organization add-member / organization remove-member by unit id), OrganizationCycleError/OrganizationalUnitInUse semantics, and the no-inheritance rule; plus a pointer sentence in "The model"
  • docs: README "Permissions" section gains one sentence on the inert organizational structure

How to Test

  1. make docs — builds cleanly; the permissions guide renders the new section.
  2. Every factual claim in the section was cross-checked against the code (endpoint composition, permission strings, error→status mappings, CLI shapes, path arithmetic).

Notes

None — documentation only.

This PR description was written with the assistance of an LLM (Claude).

@abdulrafey1 abdulrafey1 self-assigned this Jul 27, 2026
@abdulrafey1 abdulrafey1 added the documentation Improvements or additions to documentation label Jul 27, 2026
@abdulrafey1
abdulrafey1 marked this pull request as draft July 27, 2026 10:02
@abdulrafey1 abdulrafey1 changed the title docs: document the org tree docs: document the organizational structure Jul 27, 2026
@abdulrafey1
abdulrafey1 marked this pull request as ready for review July 27, 2026 10:41
Rebased onto main after the permission-groups stack merged; the branch's
commits were consolidated into one (content identical to the pre-rebase
tree).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@abdulrafey1
abdulrafey1 force-pushed the rafey/docs/org-tree branch from a58ed48 to 9f3fa68 Compare July 31, 2026 10:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants