This directory contains detailed documentation for the Holochain zomes in the Requests and Offers project.
Core zome managing user and organization profiles:
- User profile management
- Agent relationships
- Profile status tracking
- Organization profile management
- Member and coordinator management
- Organization-user relationships
- Organization status tracking
Implementation:
- Integrity:
dnas/requests_and_offers/zomes/integrity/users_organizations - Coordinator:
dnas/requests_and_offers/zomes/coordinator/users_organizations
Components:
- User Management - User profiles and relationships
- Organization Management - Organization profiles and member management
Handles system administration and status management:
- Administrator management
- Status tracking
- Entity verification
- System moderation
Implementation:
- Integrity:
dnas/requests_and_offers/zomes/integrity/administration - Coordinator:
dnas/requests_and_offers/zomes/coordinator/administration
Each zome's documentation follows this structure:
- Overview
- Technical Implementation
- Entry Types
- Link Types
- Core Functions
- Validation Rules
- Access Control
- Integration Points
- Usage Examples
-
Function Documentation:
- Document all public functions
- Include parameter and return type descriptions
- Provide error conditions and handling
-
Link Types:
- Document all link types
- Explain link creation conditions
- Describe link validation rules
-
Entry Types:
- Document all entry fields
- Include validation rules
- Provide example entries
-
Examples:
- Show common use cases
- Include error handling
- Demonstrate integration points