goose icon indicating copy to clipboard operation
goose copied to clipboard

docs: restructure recipe reference

Open dianed-square opened this issue 3 weeks ago • 1 comments

Summary

This PR reorganizes the Recipe Reference Guide to make it easier for automated updates. Also consolidates and/or streamlines some content. goose validated that existing content is preserved (with some intentional exceptions), new content is accurate, and the new structure is better for automated updates.

Documentation updates:

  • documentation/docs/guides/recipes/recipe-reference.md:
    • Move "Recipe Location" under "Recipe File Format"
    • Remove "CLI and Desktop Formats" content (originally added because of format incompatibility) and move examples to "Desktop Metadata Fields" section
    • Combine required and optional tables for core recipe schema
    • Make recipe field sections h3 subsections under "Field Specifications"
    • Add "Required" column to field tables (except extensions)
    • Pruned 'Validation Rules' section to remove rules covered by "Required" column or field descriptions
    • Move "Template Inheritance" and "Built-In Parameters" under "Template Support"
    • Add "Extension Types" list and subrecipe description field
  • documentation/docs/guides/recipes/session-recipes.md:
    • Update links to renamed sections

Type of Change

  • [ ] Feature
  • [ ] Bug fix
  • [ ] Refactor / Code quality
  • [ ] Performance improvement
  • [x] Documentation
  • [ ] Tests
  • [ ] Security fix
  • [ ] Build / Release
  • [ ] Other (specify below)

AI Assistance

  • [x] This PR was created or reviewed with AI assistance

Testing

AI code inspection and validation


  • To see the specific tasks where the Asana app for GitHub is being used, see below:
    • https://app.asana.com/0/0/1212246875397085

dianed-square avatar Dec 03 '25 23:12 dianed-square

PR Preview Action v1.6.0 :---: Preview removed because the pull request was closed. 2025-12-11 22:54 UTC

github-actions[bot] avatar Dec 03 '25 23:12 github-actions[bot]