Fix docs formatting for docs.github.com publishing (model name, lists, table cell)#1800
Open
sunbrye wants to merge 2 commits into
Open
Fix docs formatting for docs.github.com publishing (model name, lists, table cell)#1800sunbrye wants to merge 2 commits into
sunbrye wants to merge 2 commits into
Conversation
gpt-4.1 is deprecated. Update all code examples to use 'auto' for automatic model selection. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the getting-started documentation examples to avoid referencing the now-unsupported gpt-4.1 model by switching to model: "auto" / Model = "auto" across language snippets.
Changes:
- Replaced
gpt-4.1withautoin session creation examples (Node.js/TypeScript, Python, Go, .NET, Java) indocs/getting-started.md.
Show a summary per file
| File | Description |
|---|---|
| docs/getting-started.md | Updates “getting started” code samples to use model="auto" instead of gpt-4.1 to avoid relying on a deprecated model ID. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 1
|
|
||
| const client = new CopilotClient(); | ||
| const session = await client.createSession({ model: "gpt-4.1" }); | ||
| const session = await client.createSession({ model: "auto" }); |
The docs/ content is synced to docs.github.com (via github/docs-internal), where it must meet that platform's style rules. Two recurring issues were being reintroduced and fixed by hand on every sync: * Unordered lists must use asterisks (*) not hyphens (-) on docs.github.com. Converted prose bullets in features/fleet-mode.md, features/hooks.md, and hooks/post-tool-use.md (code blocks and frontmatter left untouched). * Every table cell must have a value. Filled the empty AZURE_TOKEN_CREDENTIALS Example cell in setup/azure-managed-identity.md with ManagedIdentityCredential (matches the row's description and this page's Azure scenario). Note: intentionally-blank cells that represent structure (optional 'Required' columns in property tables, section-grouping rows in troubleshooting/ compatibility.md, and the corner cell of the setup/scaling.md comparison matrix) were left as-is. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sunbrye
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The
docs/content is synced to docs.github.com (via github/docs-internal), where it must meet that platform's style rules. A few issues were breaking the docs workflow and/or being fixed by hand on every sync. This PR fixes them at the source.What
Model name — Changed
gpt-4.1→autoingetting-started.mdexamples. The docs workflow fails since GPT-4.1 is no longer supported;autois future-proof. (Original reason for this PR.)Unordered lists — Converted prose bullets from hyphens (
-) to asterisks (*) infeatures/fleet-mode.md,features/hooks.md, andhooks/post-tool-use.md. docs.github.com requires asterisks for unordered lists; code blocks and frontmatter were left untouched.Empty table cell — Filled the empty
AZURE_TOKEN_CREDENTIALSExample cell insetup/azure-managed-identity.mdwithManagedIdentityCredential(matches the row's description and this page's Azure scenario). docs.github.com requires every table cell to have a value.Intentionally left as-is
Blank cells that represent table structure were not changed, to avoid altering meaning: the optional
Requiredcolumns in thecustom-agents.md/streaming-events.mdproperty tables (blank = optional, paired with ✅ = required), the section-grouping rows introubleshooting/compatibility.md, and the corner cell of thesetup/scaling.mdcomparison matrix.Related: https://github.com/github/docs-internal/pull/61807, https://github.com/github/docs-internal/pull/62025, github/docs-team#7023