Skip to content

Docs: add visual diagrams for repository structure, data flow, consent/withdrawal, and privacy boundaries#129

Open
adhiprijal751 wants to merge 1 commit into
Digital-Life-Repository-Standard:masterfrom
adhiprijal751:feature/visual_diagrams_for_documentation
Open

Docs: add visual diagrams for repository structure, data flow, consent/withdrawal, and privacy boundaries#129
adhiprijal751 wants to merge 1 commit into
Digital-Life-Repository-Standard:masterfrom
adhiprijal751:feature/visual_diagrams_for_documentation

Conversation

@adhiprijal751

Copy link
Copy Markdown

Closes #5

What this adds

Four Mermaid diagrams in a new docs/diagrams/ directory:

  • repository-structure.md — repo directory layout and .life zip package structure
  • data-flow.md — authoring pipeline (DLRS record → .life) and 5-stage runtime assembly pipeline
  • consent-withdrawal.md — consent evidence requirements and withdrawal polling lifecycle
  • privacy-boundaries.md — S0–S4 sensitivity levels and Git vs external storage boundaries

Files changed

  • docs/diagrams/ (new directory, 4 files)
  • docs/architecture.md — added links to new diagrams
  • README.en.md — added Visual Diagrams link in documentation section

Testing

No automated tests affected. All existing CI checks pass (diagrams are Markdown/Mermaid only).

…t/withdrawal, and privacy boundaries

Closes Digital-Life-Repository-Standard#5

- Create docs/diagrams/ with four Mermaid diagrams
- repository-structure.md: repo and .life zip layout
- data-flow.md: authoring pipeline and 5-stage runtime assembly
- consent-withdrawal.md: consent evidence and withdrawal lifecycle
- privacy-boundaries.md: sensitivity levels and storage boundaries
- Update docs/architecture.md to link to new diagrams
- Update README.en.md to link to docs/diagrams/
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.

[Good First Issue] Create visual diagrams for documentation

1 participant