Skip to content

[Good First Issue] Create visual diagrams for documentation #5

@LING71671

Description

@LING71671

Difficulty: ⭐⭐ Medium

Task

Create visual diagrams to illustrate DLRS concepts and architecture.

Expected outcome

Create at least 4 diagrams covering:

  1. DLRS repository directory structure

    • Show the folder hierarchy (humans/, schemas/, tools/, etc.)
    • Highlight key files (manifest.json, public_profile.json, etc.)
  2. Raw / Derived / Runtime / Index / Audit data flow

    • Illustrate how data flows through different layers
    • Show transformation and processing stages
  3. Consent and withdrawal lifecycle

    • Document consent collection process
    • Show withdrawal request handling
    • Illustrate takedown procedures
  4. Public registry and privacy boundary

    • Show what data is public vs private
    • Illustrate pointer-based architecture
    • Demonstrate how sensitive data stays protected

Technical requirements

  • Diagrams should preferably use Mermaid format (for version control and easy updates)
  • Alternative tools: draw.io, PlantUML, or similar
  • Save all diagrams to docs/diagrams/ directory
  • Update README.md or relevant docs to link to these diagrams

Notes for contributors

  • Keep diagrams simple and clear
  • Use consistent styling across all diagrams
  • Add brief explanatory text with each diagram
  • Ensure diagrams are accessible (alt text, descriptions)

See Good First Issues Guide for more details.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions