From 89c8824aff1f5e781aed73dc3adc38deb7fcbbf8 Mon Sep 17 00:00:00 2001 From: Richard Ward Date: Wed, 31 Dec 2025 13:41:52 +0000 Subject: [PATCH] docs: json,script,packages (2 files) --- packages/json_script_example/README.md | 16 +++++++++++++++- packages/json_script_example/seed/metadata.json | 12 ------------ 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/packages/json_script_example/README.md b/packages/json_script_example/README.md index cd3e6c63d..0ac66dbd4 100644 --- a/packages/json_script_example/README.md +++ b/packages/json_script_example/README.md @@ -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` diff --git a/packages/json_script_example/seed/metadata.json b/packages/json_script_example/seed/metadata.json index a35490bda..56578460d 100644 --- a/packages/json_script_example/seed/metadata.json +++ b/packages/json_script_example/seed/metadata.json @@ -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",