diff --git a/cookbook/copilot-sdk/README.md b/cookbook/copilot-sdk/README.md index e530c563..53c91a70 100644 --- a/cookbook/copilot-sdk/README.md +++ b/cookbook/copilot-sdk/README.md @@ -79,7 +79,7 @@ go run .go ## Contributing - Propose or add a new recipe by creating a markdown file in your language's `cookbook/` folder and a runnable example in `recipe/` -- Follow repository guidance in [CONTRIBUTING.md](../CONTRIBUTING.md) +- Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md) ## Status diff --git a/cookbook/copilot-sdk/dotnet/README.md b/cookbook/copilot-sdk/dotnet/README.md index 4e5f84e5..6e3d0bdd 100644 --- a/cookbook/copilot-sdk/dotnet/README.md +++ b/cookbook/copilot-sdk/dotnet/README.md @@ -12,8 +12,8 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with ## Contributing -Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). +Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md). ## Status -This README is a scaffold; recipe files are placeholders until populated. +These recipes are now complete and ready to use; the cookbook will continue to evolve as new scenarios are added. diff --git a/cookbook/copilot-sdk/dotnet/pr-visualization.md b/cookbook/copilot-sdk/dotnet/pr-visualization.md index 99941534..f427ebe1 100644 --- a/cookbook/copilot-sdk/dotnet/pr-visualization.md +++ b/cookbook/copilot-sdk/dotnet/pr-visualization.md @@ -32,7 +32,7 @@ dotnet run dotnet run -- --repo github/copilot-sdk ``` -## Full example: Program.cs +## Full example: pr-visualization.cs ```csharp using System.Diagnostics; diff --git a/cookbook/copilot-sdk/go/README.md b/cookbook/copilot-sdk/go/README.md index 0fed547f..3bc15a6d 100644 --- a/cookbook/copilot-sdk/go/README.md +++ b/cookbook/copilot-sdk/go/README.md @@ -12,8 +12,8 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with ## Contributing -Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). +Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md). ## Status -This README is a scaffold; recipe files are placeholders until populated. +These recipes are complete, practical examples and can be used directly or adapted for your own projects. diff --git a/cookbook/copilot-sdk/go/pr-visualization.md b/cookbook/copilot-sdk/go/pr-visualization.md index a4be9e15..e8046733 100644 --- a/cookbook/copilot-sdk/go/pr-visualization.md +++ b/cookbook/copilot-sdk/go/pr-visualization.md @@ -26,13 +26,13 @@ go get github.com/github/copilot-sdk/go ```bash # Auto-detect from current git repo -go run main.go +go run pr-visualization.go # Specify a repo explicitly -go run main.go --repo github/copilot-sdk +go run pr-visualization.go -repo github/copilot-sdk ``` -## Full example: main.go +## Full example: pr-visualization.go ```go package main diff --git a/cookbook/copilot-sdk/nodejs/README.md b/cookbook/copilot-sdk/nodejs/README.md index 1c80411c..0e419476 100644 --- a/cookbook/copilot-sdk/nodejs/README.md +++ b/cookbook/copilot-sdk/nodejs/README.md @@ -12,7 +12,7 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with ## Contributing -Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). +Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md). ## Status diff --git a/cookbook/copilot-sdk/nodejs/pr-visualization.md b/cookbook/copilot-sdk/nodejs/pr-visualization.md index fd8907fe..1dba238a 100644 --- a/cookbook/copilot-sdk/nodejs/pr-visualization.md +++ b/cookbook/copilot-sdk/nodejs/pr-visualization.md @@ -29,13 +29,13 @@ npm install -D typescript tsx @types/node ```bash # Auto-detect from current git repo -npx tsx pr-breakdown.ts +npx tsx pr-visualization.ts # Specify a repo explicitly -npx tsx pr-breakdown.ts --repo github/copilot-sdk +npx tsx pr-visualization.ts --repo github/copilot-sdk ``` -## Full example: pr-breakdown.ts +## Full example: pr-visualization.ts ```typescript #!/usr/bin/env npx tsx diff --git a/cookbook/copilot-sdk/nodejs/recipe/README.md b/cookbook/copilot-sdk/nodejs/recipe/README.md index 0ea2a276..6ad74391 100644 --- a/cookbook/copilot-sdk/nodejs/recipe/README.md +++ b/cookbook/copilot-sdk/nodejs/recipe/README.md @@ -54,7 +54,7 @@ npx tsx managing-local-files.ts ## Local SDK Development -The `package.json` references the local Copilot SDK using `"file:../../.."`. This means: +The `package.json` references the local Copilot SDK using `"*"`, which resolves to the local SDK source. This means: - Changes to the SDK source are immediately available - No need to publish or install from npm @@ -63,7 +63,7 @@ The `package.json` references the local Copilot SDK using `"file:../../.."`. Thi If you modify the SDK source, you may need to rebuild: ```bash -cd ../../.. +cd ../../src npm run build ``` diff --git a/cookbook/copilot-sdk/python/README.md b/cookbook/copilot-sdk/python/README.md index ce41949c..e0324d69 100644 --- a/cookbook/copilot-sdk/python/README.md +++ b/cookbook/copilot-sdk/python/README.md @@ -12,8 +12,8 @@ This folder hosts short, practical recipes for using the GitHub Copilot SDK with ## Contributing -Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../CONTRIBUTING.md). +Add a new recipe by creating a markdown file in this folder and linking it above. Follow repository guidance in [CONTRIBUTING.md](../../../CONTRIBUTING.md). ## Status -This README is a scaffold; recipe files are placeholders until populated. +These recipes are complete and ready to use; new contributions and additional recipes are welcome. diff --git a/cookbook/copilot-sdk/python/pr-visualization.md b/cookbook/copilot-sdk/python/pr-visualization.md index 93900ed7..3d8b7969 100644 --- a/cookbook/copilot-sdk/python/pr-visualization.md +++ b/cookbook/copilot-sdk/python/pr-visualization.md @@ -27,13 +27,13 @@ pip install copilot-sdk ```bash # Auto-detect from current git repo -python pr_breakdown.py +python pr_visualization.py # Specify a repo explicitly -python pr_breakdown.py --repo github/copilot-sdk +python pr_visualization.py --repo github/copilot-sdk ``` -## Full example: pr_breakdown.py +## Full example: pr_visualization.py ```python #!/usr/bin/env python3 @@ -192,6 +192,7 @@ The current working directory is: {os.getcwd()} session.send(prompt=user_input) session.wait_for_idle() + session.destroy() client.stop() if __name__ == "__main__": diff --git a/cookbook/copilot-sdk/python/recipe/README.md b/cookbook/copilot-sdk/python/recipe/README.md index 0a0cf1d8..53d78b0a 100644 --- a/cookbook/copilot-sdk/python/recipe/README.md +++ b/cookbook/copilot-sdk/python/recipe/README.md @@ -48,13 +48,13 @@ python managing_local_files.py ## Local SDK Development -The `requirements.txt` installs the local Copilot SDK using `-e ../..` (editable install). This means: +The `requirements.txt` installs the Copilot SDK package from PyPI. This means: -- Changes to the SDK source are immediately available -- No need to publish or install from PyPI -- Perfect for testing and development +- You get the latest stable release of the SDK +- No need to build from source +- Perfect for using the SDK in your projects -If you modify the SDK source, Python will automatically use the updated code (no rebuild needed). +If you want to use a local development version, edit requirements.txt to use `-e ../..` for editable mode development. ## Python Best Practices