Update README title and add demos folder #75
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request updates the repository branding and documentation structure. The main changes include updating the README title to "GitHub Copilot CLI SDKs", adding a banner image, expanding the introduction with more detailed descriptions of the SDK's capabilities, and creating new documentation folders for examples and demos.
Changes:
- Updated README title and added enhanced product descriptions
- Added banner image (assets/RepoHeader_01.png)
- Created examples/ and demos/ folders with README files for organizing sample projects and video content
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updated title to include "GitHub" branding, added banner image reference, expanded introduction with SDK capabilities description, and added link to examples folder |
| examples/README.md | New file with structure for sample projects and video links, includes table referencing SDK-specific examples |
| demos/README.md | New file nearly identical to examples/README.md with same structure for samples and videos |
| assets/RepoHeader_01.png | New banner image file (binary) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| All SDKs are in technical preview and may change in breaking ways as we move towards a stable release. | ||
| Agents for every app. | ||
|
|
||
| Embed Copilot's agentic workflows in your application—now available in Technical preview as a programmable SDK for Python, TypeScript, Go, and .NET. |
There was a problem hiding this comment.
The capitalization of "Technical preview" should be lowercase. It should read "technical preview" as this is not a proper noun and should follow standard sentence capitalization.
| Embed Copilot's agentic workflows in your application—now available in Technical preview as a programmable SDK for Python, TypeScript, Go, and .NET. | |
| Embed Copilot's agentic workflows in your application—now available in technical preview as a programmable SDK for Python, TypeScript, Go, and .NET. |
| # Demos & Examples | ||
|
|
||
| ## Sample Projects | ||
|
|
||
| Explore complete sample projects and tutorials at **[copilot-sdk-samples.coreai.diy](https://copilot-sdk-samples.coreai.diy/)**. | ||
|
|
||
| Quick start examples are also included with each SDK: | ||
|
|
||
| | SDK | In-Repo Examples | | ||
| |-----|------------------| | ||
| | Node.js | [`nodejs/examples/`](../nodejs/examples/) | | ||
| | Python | [`python/`](../python/) | | ||
| | Go | [`go/`](../go/) | | ||
| | .NET | [`dotnet/`](../dotnet/) | | ||
|
|
||
| ## Videos | ||
|
|
||
| | Title | Description | Link | | ||
| |-------|-------------|------| | ||
| | | | | | ||
|
|
||
| <!-- Add videos above --> | ||
|
|
||
| ## Contributing | ||
|
|
||
| Have a demo or sample to share? Open a PR to add it to this list. |
There was a problem hiding this comment.
Both examples/README.md and demos/README.md appear to have nearly identical content. This creates potential confusion about which folder to use. Consider consolidating these into a single folder or clearly differentiating their purposes. If "examples" is meant for code samples and "demos" for videos, the content should reflect that distinction rather than duplicating the same structure in both files.
Changes