Updated documentation with architecture changes

This commit is contained in:
Nathan Schneider
2025-05-12 23:18:34 -06:00
parent bec25d8622
commit 2a9d4669f0
2 changed files with 13 additions and 5 deletions

View File

@@ -13,7 +13,7 @@ This is a prototype website, built in Hugo, to enable communities to develop cus
## Content Organization
- **Components**: Building blocks of a protocol, defined in `/data/components/*.yaml`
- **Stages and Components**: Building blocks of a protocol, now consolidated in `/data/stages_array.yaml`
- **Templates**: Complete predefined protocols with content for all fields, defined in `/static/js/templates/*.js`
## Data Model
@@ -21,6 +21,7 @@ This is a prototype website, built in Hugo, to enable communities to develop cus
The application maintains a hierarchical data model:
- **Stages** → **Components****Fields**
- Each field is populated with content directly from templates
- Stages now contain their components directly in a cleaner, more maintainable structure
## Core Features
@@ -46,6 +47,8 @@ Templates provide complete content for dispute resolution protocols:
3. **Enhanced debugging**: Added detailed logging for template application
4. **Component titles**: Simplified all component titles to be more direct and consistent
5. **Preview mode**: Improved rendering of protocol content with Markdown support
6. **Consolidated data structure**: Combined stages and components into a unified structure for better maintainability
7. **Improved template selection**: Updated the template selector from a dropdown to an expandable section with descriptions
## Deployment
@@ -59,4 +62,4 @@ Templates provide complete content for dispute resolution protocols:
- `/static/js/templates/index.js`: Register new templates in the central registry
- `/static/js/builder.js`: Modify core interface functionality
- `/static/css/main.css`: Adjust styling and responsive behavior
- `/data/components/*.yaml`: Edit component titles and structure
- `/data/stages_array.yaml`: Edit stages and components structure in one consolidated file