docs: clarify picoschema usage in frontmatter docs#402
Open
nickita-khylkouski wants to merge 2 commits intogoogle:mainfrom
Open
docs: clarify picoschema usage in frontmatter docs#402nickita-khylkouski wants to merge 2 commits intogoogle:mainfrom
nickita-khylkouski wants to merge 2 commits intogoogle:mainfrom
Conversation
- Change input.default type from 'any' to 'Map<string,any>' - Aligns documentation with TypeScript implementation - Fixes google#306
- Add Picoschema links to input.schema and output.schema descriptions - Explain that Picoschema is a compact YAML format that compiles to JSON Schema - Resolves confusion about schema syntax vs standard JSON Schema Fixes google#307
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies that schemas in Dotprompt frontmatter use Picoschema format—not standard JSON Schema. Adds links to the Picoschema reference page to help users understand the compact YAML syntax used in examples.
Changes
input.schemadescription to mention Picoschema with linkoutput.schemadescription to mention Picoschema with linkContext
Issue #307 raised confusion because the documentation mentioned "JSON Schema" but examples used Picoschema syntax (e.g.,
name: string,tags(array): string). This change makes the schema format explicit.Reference
Fixes #307