Fix docs automation to use toolset IDs instead of display names #1780
+5
−7
Conversation
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
The generate-docs command now outputs toolset IDs (e.g., `actions`, `code_security`) wrapped in backticks instead of display names (e.g., "Actions", "Code Security"). This ensures the manual changes from PR #1756 persist when the docs are regenerated, fixing the issue where users need to configure the actual toolset ID, not the display name. Changes: - Modified generateRemoteToolsetsDoc() to use `idStr` instead of `formattedName()` - Modified generateRemoteOnlyToolsetsDoc() to use `idStr` instead of `formattedName()` - Both functions now wrap the toolset ID in backticks for clarity Co-authored-by: SamMorrowDrums <4811358+SamMorrowDrums@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update automation docs to specify correct toolset names
Fix docs automation to use toolset IDs instead of display names
Jan 10, 2026
SamMorrowDrums
approved these changes
Jan 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the documentation automation to generate toolset IDs (e.g., `actions`) instead of formatted display names (e.g., "Actions") in docs/remote-server.md. This ensures that the automation preserves the manual corrections from PR #1756, which showed users the actual configuration values they need to use.
Changes:
- Updated
generateRemoteToolsetsDoc()to output toolset IDs in backticks instead of formatted display names - Updated
generateRemoteOnlyToolsetsDoc()with the same change for consistency - Removed unused
formattedNamevariable declarations in both functions
|
unset |
This comment has been minimized.
This comment has been minimized.
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.
Summary
Updates
script/generate-docsto output toolset IDs (e.g.,`actions`) instead of display names (e.g., "Actions") indocs/remote-server.md. This preserves the manual changes from PR #1756, which corrected the docs to show users the actual configuration values they need.Why
PR #1756 manually updated toolset names to use real IDs that users must configure. The automation was still generating display names via
formatToolsetName(), which would overwrite those changes on next run.What changed
generateRemoteToolsetsDoc(): UseidStrwrapped in backticks instead offormatToolsetName(idStr)generateRemoteOnlyToolsetsDoc(): Same changeformattedNamevariable declarations (2 locations)MCP impact
Prompts tested (tool changes only)
N/A
Security / limits
Tool renaming
Lint & tests
./script/lint./script/testDocs
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.