Skip to content

Conversation

@m-y-mo
Copy link
Contributor

@m-y-mo m-y-mo commented Oct 24, 2025

Update ReadMe and Grammar.md to incorporate new features and to provide more explanations and examples for some existing features.

Copilot AI review requested due to automatic review settings October 24, 2025 10:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README.md and GRAMMAR.md documentation files to incorporate new features and provide more comprehensive explanations and examples for existing functionality. The updates focus on improving documentation clarity, adding detailed examples for templating features, and explaining the YAML file structure and cross-referencing system.

Key changes:

  • Added comprehensive documentation for YAML file headers, filetypes, and filekey cross-referencing system
  • Expanded explanations for repeat_prompt functionality with templating, async execution, and shell tasks
  • Added documentation for new features: reusable tasks/prompts, model configs, and environment variable passing

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
taskflows/GRAMMAR.md Expanded feature documentation including repeat_prompt patterns, async execution, reusable tasks/prompts, model configs, and reorganized sections for clarity
README.md Added comprehensive YAML file structure documentation, expanded personality/toolbox explanations, and added new sections for prompts, model configs, and environment variables

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Contributor

@p- p- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow lots of Doc 👍
I think we should also check the order of the subchapters in a later step. E.g. I think the doc for task flow should be the top one. WDYT?

m-y-mo and others added 14 commits October 24, 2025 12:29
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
Co-authored-by: Peter Stöckli <p-@github.com>
@m-y-mo
Copy link
Contributor Author

m-y-mo commented Oct 24, 2025

Yea it's probably best to read the updated README.md and GRAMMAR.md as a whole to check that it makes sense. There are some dependencies between files, so taskflows are after toolboxes and personalities because it uses those. Actually toolboxes should go first because personality uses toolboxes

@p-
Copy link
Contributor

p- commented Oct 24, 2025

Yeah, let's have a look at it another time. I'd argue from another standpoint 😆 (taskflow should go first because it pulls everything together 😉 ; it is a high level view of sorts)

@m-y-mo
Copy link
Contributor Author

m-y-mo commented Oct 24, 2025

Thanks. I'll merge it for now to avoid merge conflict in case someone else wants to change these files, but please take a look at the new files and submit a PR if you spot anything. I've no preference of whether toolboxes or taskflows should go first but either of them should go before personalities for consistency (either because of dependency or because taskflow is more central). Maybe these could go under a section called "Running a taskflow" with a brief header explaining their roles and dependencies, then order according to taskflow, personality, toolboxes?

@m-y-mo m-y-mo merged commit 8e3784a into main Oct 24, 2025
5 checks passed
@m-y-mo m-y-mo deleted the update_readme branch October 24, 2025 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants