docs: fix content gaps, CI detection, and logging#2808
Merged
heyitsaamir merged 4 commits intomainfrom Apr 30, 2026
Merged
Conversation
…leanup - Add SubmitData + sub-route handler docs for TypeScript and Python - Mark C# as N/A (no sub-routing), keep its original "Server Handlers" structure - Fix deploy workflow: move NODE_ENV=production to build step so prebuild inherits it - Fix generate script: track content gaps in production codepath so CI actually catches them - Fix Python logging docs: accurate description, no custom logger injection - Move child-logger heading into includes so it only renders for TypeScript - Remove blank observability index page - Add devblogs link to blog posts Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Teams SDK docs templates/includes and the docs deploy pipeline to close language-content gaps, improve prod-mode gap detection, and align logging guidance.
Changes:
- Refactors adaptive-cards “Executing Actions” routing/handler docs into a shared
handlers-sectioninclude with TS/Python content and C# “Server Handlers”. - Fixes
generate-language-docs.tsproduction-mode gap tracking so missing/empty sections are recorded incontentGapsManifest. - Adjusts docs deploy workflow to ensure production-mode docs generation isn’t overwritten during
npm run build, and updates observability/logging + blog content.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| teams.md/src/pages/templates/in-depth-guides/observability/logging.mdx | Removes shared “Child Loggers” heading so it can be language-specific via includes. |
| teams.md/src/pages/templates/in-depth-guides/observability/README.mdx | Removes blank observability index page. |
| teams.md/src/pages/templates/in-depth-guides/adaptive-cards/executing-actions.mdx | Replaces inline routing/handler docs with <LanguageInclude section="handlers-section" />. |
| teams.md/src/components/include/in-depth-guides/observability/logging/typescript.incl.md | Adds “## Child Loggers” heading within TS-only include section. |
| teams.md/src/components/include/in-depth-guides/observability/logging/python.incl.md | Updates Python logging guidance to standard logging + microsoft_teams logger hierarchy; marks child logger section N/A. |
| teams.md/src/components/include/in-depth-guides/adaptive-cards/executing-actions/typescript.incl.md | Adds TS “Routing & Handlers” section with SubmitData + sub-route examples. |
| teams.md/src/components/include/in-depth-guides/adaptive-cards/executing-actions/python.incl.md | Adds Python “Routing & Handlers” section with SubmitData + decorator examples. |
| teams.md/src/components/include/in-depth-guides/adaptive-cards/executing-actions/csharp.incl.md | Adds C# “Server Handlers” section structure for card actions. |
| teams.md/scripts/generate-language-docs.ts | Fixes prod-mode section-gap tracking behavior. |
| teams.md/blog/2026-04-28-teams-cli-preview/index.md | Adds devblogs cross-link callout. |
| teams.md/blog/2026-04-17-bring-your-agent-to-teams/index.md | Adds devblogs cross-link callout. |
| .github/workflows/deploy-teams-docs.yml | Moves NODE_ENV=production to build step; changes docs/llms generation ordering. |
MehakBindra
approved these changes
Apr 30, 2026
…sing file tracking - restore separate generate:docs step before generate:llms so llms.txt reads from fresh docs - keep NODE_ENV=production on both generate:docs and build steps - fix whitespace in conditional - remove trailing commas from standalone TS snippet - track missing include files as content gaps in production codepath Co-Authored-By: Claude <noreply@anthropic.com>
… fix sentence - remove misleading claim that both catch-all and sub-route handlers fire together - dedup language entries in contentGapsManifest to avoid inflated reports - rephrase Python logging default-logger to a complete sentence Co-Authored-By: Claude <noreply@anthropic.com>
Wrong post — the devblogs URL is for the CLI post, not this one. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
teams.md/src/components/include/in-depth-guides/observability/logging/python.incl.md:7
- [HIGH]
default-logger/package-namecontent doesn’t fit howlogging.mdxcomposes the sentence (inline “set to … from the … package”). For Python this currently reads like the default logger comes “frommicrosoft-teams-common”, and the inserted text isn’t a logger instance name. Suggest making that sentence language-specific (move it into includes / inline LanguageInclude content) or adjust these sections to be a concise inline identifier + correct source (e.g., stdliblogging).
<!-- default-logger -->
Python's standard `logging` module, using `logging.getLogger(__name__)` per module.
<!-- package-name -->
`microsoft-teams-common`
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.
Summary
NODE_ENV=productionwas on a separategenerate:docsstep, thennpm run buildre-ran it viaprebuildwithout the env var, overwriting prod output with[Dev]markers. moved env to the build stepcontentGapsManifest, so the exit check never firedConsoleFormatter)Test plan
NODE_ENV=production npm run generate:docspasses with 0 content gaps