microsoft / microsoft/semantic-kernel

New Feature : Improve Python connector extras documentation and optional dependency compatibility details

Open
#14,398 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
28.6k
Forks
4.8k
Avg merge
14h 13m
Merged PRs (30d)
18

Description

Hi team,

I’m interested in contributing to Semantic Kernel and would like to work on improving the documentation around Python connector extras and optional dependency compatibility.

The current issue (#14327) highlights that some connectors require optional extras, but the documentation does not clearly explain:

  • which connectors require which extras
  • how optional dependencies affect functionality
  • how users should install and configure these extras
  • compatibility notes for different environments

I would like to take ownership of this issue and contribute a clear, structured update to the Python docs that covers:

  • a table of connectors and their required/optional extras
  • installation examples (pip extras, environment notes)
  • compatibility notes for common setups
  • guidance for users on troubleshooting missing extras

Please let me know if there are any specific expectations or preferred formats before I begin.

Thanks,
Ablaze

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with issue #14327 and the existing Python connector documentation. Identify each connector's required and optional extras, installation and configuration guidance, environment compatibility notes, and missing-extra troubleshooting. Done means the Python docs contain a structured connector/extras table, installation examples, compatibility guidance, and troubleshooting information.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.