Skip to content

Commit 584a239

Browse files
rinceyuanj-zhangyiyuan
andauthored
docs: apply style guide conventions and fix trailing whitespace (#1979)
Apply the docs style guide (.github/instructions/docs-style.instructions.md): - Replace 'etc.' with 'and more' (4 occurrences across 3 files) - Replace 'e.g.' with 'For example' (1 occurrence in code comment) - Remove trailing whitespace (3 occurrences across 3 files) Only safe files with no open PR conflicts were modified. Co-authored-by: j-zhangyiyuan <j-zhangyiyuan@microsoft.com>
1 parent 746fdd2 commit 584a239

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copilot SDK
1+
# Copilot SDK
22

33
Welcome to the GitHub Copilot SDK docs. Whether you're building your first Copilot-powered app or deploying to production, you'll find what you need here.
44

docs/auth/authenticate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The GitHub Copilot SDK supports multiple authentication methods to fit different
99
| [GitHub Signed-in User](#github-signed-in-user) | Interactive apps where users sign in with GitHub | Yes |
1010
| [OAuth GitHub App](#oauth-github-app) | Apps acting on behalf of users via OAuth | Yes |
1111
| [Environment Variables](#environment-variables) | CI/CD, automation, server-to-server | Yes |
12-
| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Azure AI Foundry, OpenAI, etc.) | No |
12+
| [BYOK (Bring Your Own Key)](./byok.md) | Using your own API keys (Azure AI Foundry, OpenAI, and more) | No |
1313

1414
## GitHub signed-in user
1515

@@ -221,7 +221,7 @@ client.start().get();
221221

222222
**Supported token types:**
223223
* `gho_` - OAuth user access tokens
224-
* `ghu_` - GitHub App user access tokens
224+
* `ghu_` - GitHub App user access tokens
225225
* `github_pat_` - Fine-grained personal access tokens
226226

227227
**Not supported:**
@@ -275,7 +275,7 @@ await client.start()
275275
</details>
276276

277277
**When to use:**
278-
* CI/CD pipelines (GitHub Actions, Jenkins, etc.)
278+
* CI/CD pipelines (GitHub Actions, Jenkins, and more)
279279
* Automated testing
280280
* Server-side applications with service accounts
281281
* Development when you don't want to use interactive login

docs/features/cloud-sessions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Capture the URL by subscribing to `session.info` and filtering by `infoType: "re
235235
session.on("session.info", (event) => {
236236
if (event.data?.infoType === "remote" && event.data.url) {
237237
console.log("Open from web or mobile:", event.data.url);
238-
// e.g. surface in your UI as a shareable link or QR code.
238+
// For example, surface in your UI as a shareable link or QR code.
239239
}
240240
});
241241
```

docs/setup/choosing-a-setup-path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Use this table to find the right guides based on what you need to do:
8888
| Getting started quickly | [Default Setup (Bundled CLI)](./bundled-cli.md) |
8989
| Use your own CLI binary or server | [Local CLI](./local-cli.md) |
9090
| Users sign in with GitHub | [GitHub OAuth](./github-oauth.md) |
91-
| Use your own model keys (OpenAI, Azure, etc.) | [BYOK](../auth/byok.md) |
91+
| Use your own model keys (OpenAI, Azure, and more) | [BYOK](../auth/byok.md) |
9292
| Azure BYOK with Managed Identity (no API keys) | [Azure Managed Identity](./azure-managed-identity.md) |
9393
| Run the SDK on a server | [Backend Services](./backend-services.md) |
9494
| Configure SDK options for concurrent users | [Multi-tenancy and server deployments](./multi-tenancy.md) |

docs/troubleshooting/mcp-debugging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,10 +446,10 @@ When opening an issue or asking for help, collect:
446446

447447
* [ ] SDK language and version
448448
* [ ] CLI version (`copilot --version`)
449-
* [ ] MCP server type (Node.js, Python, .NET, Go, Rust, etc.)
449+
* [ ] MCP server type (Node.js, Python, .NET, Go, Rust, and more)
450450
* [ ] Full MCP server configuration (redact secrets)
451451
* [ ] Result of manual `initialize` test
452-
* [ ] Result of manual `tools/list` test
452+
* [ ] Result of manual `tools/list` test
453453
* [ ] Debug logs from SDK
454454
* [ ] Any error messages
455455

0 commit comments

Comments
 (0)