Improve documentation clarity based on code review feedback

Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-01-07 19:27:15 +00:00
parent 5172de6693
commit 258dfa07d7
3 changed files with 16 additions and 13 deletions

View File

@@ -346,7 +346,7 @@
"description": "Package structure template mapping paths to schemas",
"additionalProperties": {
"type": "string",
"description": "Schema name for this location"
"description": "Schema name for this location. Note: scripts/*.json must follow script_schema.json with full function implementations (body), not just metadata declarations."
},
"default": {
"package.json": "metadata",

View File

@@ -411,7 +411,8 @@ function generate(config: PackageConfig): GeneratedFile[] {
files.push({ path: 'seed/metadata.json', content: generateMetadata(config) })
files.push({ path: 'seed/components.json', content: generateComponentsJson(config) })
files.push({ path: 'seed/layout.json', content: generateLayoutJson(config) })
// Removed functions.json generation - stick to proper script schema files with implementations
// Note: functions.json removed - script_schema.json requires full implementations with function bodies,
// not just metadata declarations. Use properly named script files (e.g., automation.json, lifecycle.json)
files.push({ path: 'seed/index.ts', content: generateIndexTs(config) })
// Schema files

View File

@@ -37,25 +37,27 @@ Test packages with different user contexts:
- **Admin (Nerd Mode)** - Level 4 with nerdMode enabled
- **Supergod** - Level 6 user
## How It Works
1. **JSON script packages** in `/packages/*/seed/scripts/` define UI component trees
2. **Mock data** mirrors the output structure produced by the JSON scripts
3. **PackageRenderer** (still the runtime entry) converts the component tree to React components
4. **Component Registry** maps package-defined type names to React implementations
## How It Works
## Package Structure
Each JSON script package follows this structure:
1. **JSON script packages** in `/packages/*/seed/scripts/` define UI component trees
2. **Mock data** mirrors the output structure produced by the JSON scripts
3. **PackageRenderer** (still the runtime entry) converts the component tree to React components
4. **Component Registry** maps package-defined type names to React implementations
## Package Structure
Each JSON script package follows this structure:
```
packages/
└── {package_name}/
└── seed/
└── seed/
├── metadata.json # Package info
├── components.json # Component definitions
└── scripts/
└── [script-name].json # JSON script definitions (e.g., automation.json)
└── [script-name].json # JSON script definitions following script_schema.json
# Must include full function implementations with bodies,
# not just metadata declarations (e.g., automation.json)
```
## JSON Script Output