Skip to content

Post-Documentation restructure: verify potential gaps / fix some errors #2670

@corinagum

Description

@corinagum

(Original PR: #2668)

Note: after running npm run build or npm run start in the teams.md folder in dev mode, a markdown file scripts/generated/content-gaps.md can be reviewed for the below. Also see teams.md/static/missing-pages.json for pages that exist for one or two languages but not all languages.

Page gaps

This list has one or two languages documented but missing for other languages. We just need to verify if it is intentional for this list, or a gap.

  • on-activity - Python
  • activity-ref - None for C#, Python
  • ai/a2a - None for C#, Python
  • tabs section - Python

Content errors or gaps

These are sections with errors or gaps that I took brief note of in favor of speed. We will need to verify these sections.

  • api - Copilot added content to fill gaps, 'proactive api' needs to be checked
  • on-event - C# docs needs corrections
  • hosting-static-apps - Copilot added content to fill gaps, needs to be checked
  • graph - Python: copilot filled gaps, check
  • execute-action - C#, Python: Input association data received check
  • creating-dialogs - C#, Python: teams-js using old version?
  • action-commands - Python: handle submission
  • message-extensions/settings- C#, Python: teams-js v2, not v1
  • in-depth-guides/user-authentication - all: verify docs were combined correctly
  • in-depth-guides/user-authentication v.s. teams/user-authentication - do we want to combine? Or rename in-depth to More on user authentication? File names are identical and I am concerned about causing confusion.
  • ai/function-calling
  • mcp files - sanity check copilot's work
  • ai/setup-and-prereqs C# and TS: missing additional notes section ok?
  • ai/setup-and-prereqs - Python, TS: package-install section
  • ai Typescript: AZURE_OPENAI_MODEL_DEPLOYMENT_NAME fix? Except for ai sample, teams.ts generally uses AZURE_OPENAI_MODEL
  • ai/best-practices - Python: addAiGenerated, addCitations - fix?
  • "The Azure OpenAI SDK handles API versioning automatically. You don't need to specify an API version manually." - note only for C#, should we make for all three?
  • ai/best-practices - gifs have strong flicker
  • ai/function-calling - mermaid chart added by copilot to all pages - check for each language
  • creating-dialogs: C# has Setting up Embedded Web Content section but others do not. Ok?
  • handling-dialog-submissions, handling-multi-step-forms - PY and TS missing 'complete' examples. ok?
  • message-extensions/search-commands - C# doesn't have select-item-code - ok?
  • References to IFFE app start in code examples should be removed from TypeScript documentation. Example: migratons/botbuilder/user-authentication, several in migrations section:
+    (async () => {
+      await app.start();
+    })();

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions