docs: json,script,packages (2 files)

This commit is contained in:
Richard Ward
2025-12-31 13:41:52 +00:00
parent 7645d35198
commit 89c8824aff
2 changed files with 15 additions and 13 deletions

View File

@@ -14,9 +14,10 @@ All functions in this package are defined in `seed/script.json` and executed via
json_script_example/
├── README.md # This file
├── MODULES.md # Import/export guide
├── TYPES.md # Type system documentation
├── seed/
│ ├── metadata.json # Package configuration
│ ├── script.json # Main example functions
│ ├── script.json # Main example functions (with docstrings!)
│ ├── math_utils.json # Math utility module
│ ├── validation.json # Validation module
│ ├── combined_example.json # Multi-module example
@@ -30,6 +31,19 @@ json_script_example/
└── icon.svg # Package icon
```
## Documentation
All functions include **comprehensive docstrings** with:
- **Summary** - One-line description
- **Detailed description** - Full explanation of behavior
- **Parameter documentation** - Type, description for each param
- **Return type documentation** - What the function returns
- **Usage examples** - Code samples showing how to use the function
- **Related functions** - Cross-references to similar functions
- **Metadata** - Version, tags, categories
See [SCRIPT_JSON_DOCSTRINGS.md](../shared/seed/SCRIPT_JSON_DOCSTRINGS.md) for the full docstring specification.
## Exported Functions
### 1. `all_expressions`

View File

@@ -50,18 +50,6 @@
"styles": "seed/styles.json",
"types": "seed/types.json"
},
"storybook": {
"stories": [
{
"name": "Expression Examples",
"render": "all_expressions"
},
{
"name": "Statement Examples",
"render": "all_statements"
}
]
},
"runtime": {
"scripts": [
"seed/script.json",