Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 14, 2025

Plan: Refactor BotBuilder Migration Documentation to Eliminate Duplication ✅

  • Move common descriptive text from include files to template files
  • Update all 8 template files to include shared content
  • Refactor all 24 include files (3 languages × 8 pages) to contain only language-specific content
  • Use <LanguageInclude> tags with specific section names instead of generic "content"
  • Verify documentation generation and build
  • Add inline content support for LanguageInclude
  • Fix rendering bugs and add explanatory text
  • Add language-specific API comparison tables for BotBuilder vs Teams SDK

Changes Made

Refactored 8 migration pages to follow best practices:

  • Main README: Moved "Why a Plugin?" section to template, uses inline content for plugin names
  • Activity Handlers: Moved description and info box to template, kept only code examples in includes
  • Adapters: Moved description and info box to template, kept only code examples in includes
  • Turn Context: Moved description to template, uses inline content for context type names
  • Sending Activities: Moved introduction to template, kept only code examples in includes
  • Proactive Activities: Moved description to template, uses inline content for method/parameter names
  • The API Client: Moved description to template, added language-specific API comparison tables
  • User Authentication: Moved description to template, uses inline content for auth method names

New Feature: Inline Content Support

Added support for inline language-specific content in templates without separate include files.

Language-Specific API Comparison Tables

Each language now has its own API comparison table with correct naming conventions:

  • TypeScript: TeamsInfo.getMembers()api.conversations.members().get()
  • C#: TeamsInfo.GetMembersAsync()context.Api.Conversations.Members.GetAsync()
  • Python: TeamsInfo.get_members()context.api.conversations.members().get()

Bug Fixes

  • Fixed malformed LanguageInclude tag in proactive-activities.mdx
  • Added explanatory text to activity-handlers and adapters pages
Original prompt

we have botbuilder packages in the teams sdk to make it backward compatible with legacy bots built using BotBuilder teams.net/Libraries/Microsoft.Teams.Plugins/Microsoft.Teams.Plugins.AspNetCore.BotBuilder at main ·… teams.py/packages/botbuilder at main · microsoft/teams.py teams.ts/packages/botbuilder at main · microsoft/teams.ts Can you add docs for each language in the Migrations section using Refer the Samples teams.py/tests/botbuilder at main · microsoft/teams.py, teams.ts/tests/botbuilder at main · microsoft/teams.ts, teams.net/Samples/Samples.BotBuilder at main · microsoft/teams.net to add code snippets .
work on the request above


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Add backward compatibility support for legacy bots using BotBuilder Add C# and Python BotBuilder migration documentation Nov 14, 2025
Copilot finished work on behalf of MehakBindra November 14, 2025 21:39
Copilot AI requested a review from MehakBindra November 14, 2025 21:39
@MehakBindra
Copy link
Contributor

@copilot avoid duplication of content between languages by also using pages/templates in addition to components

Copy link
Contributor Author

Copilot AI commented Nov 14, 2025

@copilot avoid duplication of content between languages by also using pages/templates in addition to components

Refactored the BotBuilder migration documentation to eliminate duplication. Common content is now in template files (pages/templates), with only language-specific code examples remaining in component includes. This reduced duplication by 75 lines and follows the best practices outlined in LANGUAGE-INCLUDE.md.

Changes in commit 87eb89a.

Copilot finished work on behalf of MehakBindra November 14, 2025 22:19
@MehakBindra MehakBindra marked this pull request as ready for review November 19, 2025 07:19
Copilot AI changed the title Add C# and Python BotBuilder migration documentation Add C# and Python BotBuilder migration documentation with inline content support Nov 24, 2025
Copilot finished work on behalf of MehakBindra November 24, 2025 19:53
@BasetsanaNjody
Copy link

should we apply the same feature extraction and normalization steps as inn the reference implementation

Copilot finished work on behalf of MehakBindra November 25, 2025 18:50
heyitsaamir
heyitsaamir previously approved these changes Nov 26, 2025
@MehakBindra MehakBindra merged commit b905eca into main Nov 26, 2025
2 checks passed
@MehakBindra MehakBindra deleted the copilot/add-backward-compatibility-botbuilder branch November 26, 2025 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants