Skip to content

docs: add "Use with AI tools" section to all library READMEs#38828

Draft
KarishmaGhiya wants to merge 1 commit into
Azure:mainfrom
KarishmaGhiya:karishma/readme-use-with-ai-section
Draft

docs: add "Use with AI tools" section to all library READMEs#38828
KarishmaGhiya wants to merge 1 commit into
Azure:mainfrom
KarishmaGhiya:karishma/readme-use-with-ai-section

Conversation

@KarishmaGhiya
Copy link
Copy Markdown
Member

Summary

  • Adds a new ## Use with AI tools section directly above ## Troubleshooting in every sdk/<group>/<lib>/README.md (425 files).
  • The section points readers to aka.ms/azsdk/js/ai for AI coding tool integrations (VS Code, GitHub Copilot, etc.).
  • Sample / nested READMEs (e.g. under sdk/eventhub/event-hubs/samples*/) were intentionally excluded.

Inserted content (identical in every file):

## Use with AI tools

AI coding tools such as VS Code and GitHub Copilot can help you write and debug code that uses this library. See [Using the Azure SDK for Javascript with AI tools](https://aka.ms/azsdk/js/ai) for available integrations.

Test plan

  • Spot-check rendering on a sample of READMEs (data-plane, mgmt-plane, core, identity)
  • Confirm the section appears as a sibling of Troubleshooting (not nested inside Examples)
  • Verify CI passes

🤖 Generated with Claude Code

Adds a new "## Use with AI tools" section directly above
"## Troubleshooting" in every sdk/<group>/<lib>/README.md, pointing
readers to aka.ms/azsdk/js/ai for AI coding tool integrations
(VS Code, GitHub Copilot, etc.).

Sample/nested READMEs were intentionally excluded.

Co-Authored-By: Claude Opus 4 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Untriaged
Status: No status
Status: Untriaged
Status: Untriaged

Development

Successfully merging this pull request may close these issues.

1 participant