-
Notifications
You must be signed in to change notification settings - Fork 6
update readme and grammar #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this 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.
p-
left a comment
There was a problem hiding this 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?
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>
|
Yea it's probably best to read the updated |
|
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) |
|
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? |
Update ReadMe and Grammar.md to incorporate new features and to provide more explanations and examples for some existing features.