Skip to content

docs: fix content gaps, CI detection, and logging#2808

Merged
heyitsaamir merged 4 commits intomainfrom
docs/fix-executing-actions-and-logging
Apr 30, 2026
Merged

docs: fix content gaps, CI detection, and logging#2808
heyitsaamir merged 4 commits intomainfrom
docs/fix-executing-actions-and-logging

Conversation

@heyitsaamir
Copy link
Copy Markdown
Collaborator

Summary

  • fill in missing SubmitData + sub-route handler sections for TS/Python executing-actions page. C# gets N/A with its own "Server Handlers" structure since it doesn't have sub-routing
  • fix deploy workflow — NODE_ENV=production was on a separate generate:docs step, then npm run build re-ran it via prebuild without the env var, overwriting prod output with [Dev] markers. moved env to the build step
  • fix generate script production codepath — it silently skipped missing sections without tracking them in contentGapsManifest, so the exit check never fired
  • clean up Python logging docs (no custom logger injection, just standard logging with optional ConsoleFormatter)
  • move child-logger heading into language includes so it only shows for TS
  • nuke blank observability index page
  • add devblogs links to blog posts

Test plan

  • NODE_ENV=production npm run generate:docs passes with 0 content gaps
  • C# executing-actions page shows "Server Handlers" without SubmitData/routing sections
  • TS/Python executing-actions pages show full Routing & Handlers section
  • Python logging page doesn't mention custom logger injection
  • Child Loggers heading only appears on TS logging page

…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>
Copilot AI review requested due to automatic review settings April 30, 2026 00:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-section include with TS/Python content and C# “Server Handlers”.
  • Fixes generate-language-docs.ts production-mode gap tracking so missing/empty sections are recorded in contentGapsManifest.
  • 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.

Comment thread teams.md/scripts/generate-language-docs.ts Outdated
Comment thread .github/workflows/deploy-teams-docs.yml
Comment thread teams.md/scripts/generate-language-docs.ts
…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>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.

Comment thread teams.md/scripts/generate-language-docs.ts Outdated
Comment thread teams.md/scripts/generate-language-docs.ts Outdated
Comment thread teams.md/blog/2026-04-17-bring-your-agent-to-teams/index.md Outdated
heyitsaamir and others added 2 commits April 29, 2026 19:01
… 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>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-name content doesn’t fit how logging.mdx composes the sentence (inline “set to … from the … package”). For Python this currently reads like the default logger comes “from microsoft-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., stdlib logging).
<!-- default-logger -->

Python's standard `logging` module, using `logging.getLogger(__name__)` per module.

<!-- package-name -->

`microsoft-teams-common`

@heyitsaamir heyitsaamir merged commit 6177dec into main Apr 30, 2026
6 checks passed
@heyitsaamir heyitsaamir deleted the docs/fix-executing-actions-and-logging branch April 30, 2026 02:10
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.

3 participants