Document identity model relationships #141

Merged
erik merged 2 commits from docs/task-64ef67ae-identity-model into main 2026-06-12 07:28:24 -05:00
Owner

Summary

Adds a documentation-only identity model reference for the Slugkit template site.

Task

task-64ef67ae

Changes

  • Added docs/identity-model.md with terminology mapping for identity-related code models and database tables.
  • Added Mermaid diagrams for current database relationships, current code-model relationships, and intended template-site authorship relationships.
  • Documented that the primary ActivityPub actor is the intended local post author/publisher for the template site.
  • Documented that contacts/sources are external credit/source metadata and admin/API/CLI identities are management auth only.
  • Captured the current authorIds/post_authors contact-ID ambiguity as a follow-up design issue.

Testing

  • Unit tests added/updated
  • Manual testing performed
  • ./scripts/pre-pr.sh passes

Checklist

  • ./scripts/pre-pr.sh passes
  • Documentation updated (if needed)
  • No unrelated changes included
## Summary Adds a documentation-only identity model reference for the Slugkit template site. ## Task task-64ef67ae ## Changes - Added `docs/identity-model.md` with terminology mapping for identity-related code models and database tables. - Added Mermaid diagrams for current database relationships, current code-model relationships, and intended template-site authorship relationships. - Documented that the primary ActivityPub actor is the intended local post author/publisher for the template site. - Documented that contacts/sources are external credit/source metadata and admin/API/CLI identities are management auth only. - Captured the current `authorIds`/`post_authors` contact-ID ambiguity as a follow-up design issue. ## Testing - [ ] Unit tests added/updated - [ ] Manual testing performed - [x] `./scripts/pre-pr.sh` passes ## Checklist - [x] `./scripts/pre-pr.sh` passes - [x] Documentation updated (if needed) - [x] No unrelated changes included
docs: document identity model relationships
All checks were successful
CI / build-lint-test (pull_request) Successful in 51s
216965c2cf
Task: #task-64ef67ae
Author
Owner

PR review

Summary

Approved. This PR adds the requested documentation-only identity model reference with Mermaid diagrams and explicitly separates current implementation details from the intended template-site authorship model.

Acceptance criteria

  • docs/identity-model.md exists and renders Mermaid diagrams for the current relationships.
  • The document maps concepts to code models and database tables in a table.
  • The diagrams show both current database/code relationships and the intended template-site authorship model.
  • The document explicitly explains that admin/API/CLI identity is authentication/management identity, not public authorship.
  • The document explicitly explains that contacts/sources represent external metadata/credit, not the default local post author in the template-site model.
  • The document identifies the current authorIds/post_authors ambiguity as a follow-up design issue.
  • Relevant documentation formatting/checks pass.

Blocking issues

None.

Warnings

None.

Verification

  • ./scripts/pre-pr.sh passed locally.
  • Forgejo Actions run #195 passed (build-lint-test).

Final verdict

Approved. Ready for human merge approval.

## PR review ### Summary Approved. This PR adds the requested documentation-only identity model reference with Mermaid diagrams and explicitly separates current implementation details from the intended template-site authorship model. ### Acceptance criteria - [x] `docs/identity-model.md` exists and renders Mermaid diagrams for the current relationships. - [x] The document maps concepts to code models and database tables in a table. - [x] The diagrams show both current database/code relationships and the intended template-site authorship model. - [x] The document explicitly explains that admin/API/CLI identity is authentication/management identity, not public authorship. - [x] The document explicitly explains that contacts/sources represent external metadata/credit, not the default local post author in the template-site model. - [x] The document identifies the current `authorIds`/`post_authors` ambiguity as a follow-up design issue. - [x] Relevant documentation formatting/checks pass. ### Blocking issues None. ### Warnings None. ### Verification - `./scripts/pre-pr.sh` passed locally. - Forgejo Actions run #195 passed (`build-lint-test`). ### Final verdict Approved. Ready for human merge approval.
docs: split identity diagrams for readability
All checks were successful
CI / build-lint-test (pull_request) Successful in 45s
7d59a1e3fa
Task: #task-64ef67ae
Author
Owner

PR review update

Summary

Approved after readability revision. The large database/code diagrams were split into smaller focused Mermaid diagrams, making the identity model easier to read while preserving the same documentation-only scope.

Acceptance criteria

  • docs/identity-model.md exists and renders Mermaid diagrams for the current relationships.
  • The document maps concepts to code models and database tables in a table.
  • The diagrams show both current database/code relationships and the intended template-site authorship model.
  • The document explicitly explains that admin/API/CLI identity is authentication/management identity, not public authorship.
  • The document explicitly explains that contacts/sources represent external metadata/credit, not the default local post author in the template-site model.
  • The document identifies the current authorIds/post_authors ambiguity as a follow-up design issue.
  • Relevant documentation formatting/checks pass.

Blocking issues

None.

Warnings

None.

Verification

  • ./scripts/pre-pr.sh passed locally after the readability update.
  • Forgejo Actions run #196 passed (build-lint-test).

Final verdict

Approved. Ready for human merge approval.

## PR review update ### Summary Approved after readability revision. The large database/code diagrams were split into smaller focused Mermaid diagrams, making the identity model easier to read while preserving the same documentation-only scope. ### Acceptance criteria - [x] `docs/identity-model.md` exists and renders Mermaid diagrams for the current relationships. - [x] The document maps concepts to code models and database tables in a table. - [x] The diagrams show both current database/code relationships and the intended template-site authorship model. - [x] The document explicitly explains that admin/API/CLI identity is authentication/management identity, not public authorship. - [x] The document explicitly explains that contacts/sources represent external metadata/credit, not the default local post author in the template-site model. - [x] The document identifies the current `authorIds`/`post_authors` ambiguity as a follow-up design issue. - [x] Relevant documentation formatting/checks pass. ### Blocking issues None. ### Warnings None. ### Verification - `./scripts/pre-pr.sh` passed locally after the readability update. - Forgejo Actions run #196 passed (`build-lint-test`). ### Final verdict Approved. Ready for human merge approval.
erik merged commit c394e90aed into main 2026-06-12 07:28:24 -05:00
erik deleted branch docs/task-64ef67ae-identity-model 2026-06-12 07:28:24 -05:00
Sign in to join this conversation.
No description provided.