Collections Improvement with Tasks Collection POC #270
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces enhanced collection functionality with comprehensive usage documentation. The changes enable collections to include detailed usage instructions for each item, improving discoverability and guidance for users.
- Added the
edge-ai-taskscollection with specialized chat modes and instructions for task planning and implementation - Extended collection schema and parsing to support optional
usagefields for individual items - Enhanced README generation to automatically include usage sections with anchor links
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| collections/edge-ai-tasks.collection.yml | New collection definition with usage documentation for task planning workflow |
| collections/edge-ai-tasks.md | Generated README for the new collection including usage examples |
| .schemas/collection.schema.json | Added optional usage field to collection item schema |
| yaml-parser.js | Enhanced YAML parsing to support multi-line literal blocks for usage content |
| update-readme.js | Updated README generation to include usage sections with anchor links |
| README.collections.md | Added entry for the new edge-ai-tasks collection |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Interesting idea using Collections as a way to display usage, I think it can work.
I'm not really familiar with the tasks you've used for the Collection that you're demonstrating with though, so I'll defer to @agreaves-ms on whether they are accurate usage, and whether it reads well when rendered in the Collection README.
There was a problem hiding this comment.
This is great @jeremiah-snee-openx! Thank you for adding this, nicely done.
There was a problem hiding this comment.
@jeremiah-snee-openx I did some refactoring of the update script (I'd found some bugs), which has resulted in merge conflicts. Can you tackle those in your PR and then it'll be good to merge
@aaronpowell Prior to collections being added, I had been going to PRs that introduced sets of files to see what files were meant to be used together. I actually thought collections were intended to be more granular. For example, a collection specific to just the awesome-copilot/collections/project-planning.md Lines 9 to 27 in 591d2fd When I started to create a collection for the one included in the PR, and I was frequently viewing the PR by @agreaves-ms to get idea of usage thought that it would be nice to have preserved and rendered in the collection markdown as well. |
|
@all-contributors please add @jeremiah-snee-openx for code |
|
I've put up a pull request to add @jeremiah-snee-openx! 🎉 |
3 participants
Pull Request Checklist
node update-readme.jsand verified thatREADME.mdis up to date.Description
This pull request introduces a new curated collection for advanced task planning and research, enhances schema and documentation support for usage context, and improves YAML parsing and README generation for collections. The changes make it easier to define, document, and consume collections with rich usage instructions and context.
New collection and documentation enhancements:
edge-ai-taskscollection, featuring specialized chat modes and instructions for task research, planning, and implementation, including detailed usage examples and integration guidance. [1] [2] [3]Schema and metadata improvements:
.schemas/collection.schema.jsonto support an optionalusagefield for each item, enabling richer context and documentation directly in collection definitions.README and documentation generation:
update-readme.jsto automatically include item-level usage sections in generated collection README files, linking descriptions to detailed usage instructions when available. [1] [2]YAML parsing enhancements:
yaml-parser.jsto support multi-line literal blocks (|and>) for the newusagefield and other properties, ensuring correct parsing and formatting of complex documentation in collection YAML files. [1] [2] [3]Type of Contribution
Additional Notes
Previously added files that can justifiable be organized in a collection still don't have a place for user documentation. With the addition of collections, prompt/instruction/chatmodes can now be grouped together, but still lack a home for usage information. This has sometimes been included in PRs, but is not easily discoverable.
As a POC, I created a collection with Usage info based on the PR
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.