Commit Graph
64 Commits
Author SHA1 Message Date
Evan Mattson ea9981ffaf Python: Docs: Add Microsoft Agent Framework successor callout to READMEs (#13932)
## Motivation and Context

Now that **Microsoft Agent Framework (MAF)** is the successor SDK to
Semantic Kernel, the top-level and per-language READMEs should direct
community members — especially newcomers landing here from search,
GitHub, PyPI, or NuGet — to MAF for new work, and clearly state SK's
ongoing maintenance posture.

## Description

Adds a prominent GitHub `> [!IMPORTANT]` callout, placed directly under
the existing title/badges block, to:

- `README.md` (top-level)
- `python/README.md`
- `dotnet/README.md`

Each callout:

- Names MAF as Semantic Kernel's successor SDK and links to
https://github.com/microsoft/agent-framework.
- Describes MAF as "an open, multi-language framework for building
production-grade AI agents and multi-agent workflows in .NET and
Python".
- Asks readers to use MAF for the latest abstractions to build agents,
workflows, and multi-agent orchestrations.
- States that Semantic Kernel will continue to receive minimal security
and bug fixes only.

No other README content is modified; SK identity, badges, install steps,
and quickstart samples are preserved.

## Contribution Checklist

- [x] The code builds clean without any errors or warnings — docs-only
change.
- [x] I didn't break anyone — additive callout only.
- [x] All relevant CONTRIBUTING.md sections were followed.
2026-04-30 15:18:01 +09:00
Andrewandwestey c9efdf50f5 Fix link for Chroma documentation in README (#13682)
### Motivation and Context

Link to the Chroma is incorrect.

### Description

This PR fixes link for Chroma documentation in README.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

Co-authored-by: westey <[email protected]>
2026-03-19 11:00:15 +00:00
Stephen Toub b50299be6d Upgrade to .NET 10 (#13395) 2025-12-01 17:08:24 +00:00
Alexander Batishchev f369170a15 Fixed typo in README.md (#12735)
### Description

Fixed the casing of word Core in the name of the package.

### Contribution Checklist

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2025-07-17 12:51:06 +00:00
Shawn Henry 71ddf36e1c Added ChatHistoryAgentThread to multi-agent (#11473)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
2025-06-03 15:59:02 +00:00
Shawn HenryandEvan Mattson 3224f4da0a Added missing import asyncio to agent with plugin python (#11472)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

Co-authored-by: Evan Mattson <[email protected]>
2025-04-11 08:30:02 +00:00
Evan Mattson 14d772e59f Python: Update Python min version in README (#11428)
### Motivation and Context

The README says SK Python supports min 3.9, but it is 3.10.

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

The README says SK Python supports min 3.9, but it is 3.10.

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
2025-04-08 23:14:09 +00:00
Shawn HenryandEvan Mattson 664da123e5 Updated README.md (#11372)
### Motivation and Context


### Description

Updated readme for agents

### Contribution Checklist


- [ x] The code builds clean without any errors or warnings
- [ x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ x] All unit tests pass, and I have added new tests where possible
- [ x] I didn't break anyone 😄

---------

Co-authored-by: Evan Mattson <[email protected]>
2025-04-04 15:39:57 +00:00
Dmytro Struk f85c21787f .Net: Fixed links (#11068)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

This PR fixes links that were found unreachable by `linkspector`:

https://github.com/microsoft/semantic-kernel/actions/runs/13954045797/job/39063140670?pr=11055

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2025-03-19 14:20:52 -07:00
JunandRoger Barreto b751eeedaf Python: Update README.md (#11024)
Fixed some potential misspellings/errors.

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

---------

Co-authored-by: Roger Barreto <[email protected]>
2025-03-19 07:46:15 +00:00
John Oliver 934b2bb1a1 Remove build Java badge from readme (#7561) 2024-12-11 10:21:41 +00:00
Ikko Eltociear AshimineandEvan Mattson f5facce9ec docs: update README.md (#9093)
### Motivation and Context

fixed typo.

### Description

minor fix

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

Co-authored-by: Evan Mattson <[email protected]>
2024-11-19 20:00:34 +00:00
Dmytro Struk c7b22d9efb Fixed broken links in repo (#8982) 2024-09-24 18:04:29 -07:00
SergeyMenshykh 4d73de4ad4 Remove dead link to Maven Central (#8845)
### Motivation and Context
The link no longer works and fails the PR link check job.
2024-09-17 14:13:14 +00:00
Dr. Artificial曾小健 6c0dc65d24 double 'see' fix (#8305)
double 'see' fix

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2024-08-21 09:58:07 +00:00
Kind JeffandTao Chen 1825be66d0 Python: Fix incorrect instructions in README (#8023)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

The README incorrectly suggests that Python users need to switch to C#.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

fix typo

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

Co-authored-by: Tao Chen <[email protected]>
2024-08-20 16:38:04 +00:00
Evan Mattson 4365415f83 Python: Fix some Python portions of README. (#7956)
### Motivation and Context

There are some Python related sections in the README that need
improvement.

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

In the README, point to the Python code pivot for "getting started with
Python." Add the Python API reference link instead of "coming soon."

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
2024-08-07 15:04:31 +00:00
John OliverandBruno Borges d3172f8f36 Java: Migrate java code to new repository (#7460)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

Co-authored-by: Bruno Borges <[email protected]>
2024-07-29 17:01:13 +00:00
35b52a5e45 Update README.md (#7068)
Updated README with new graphics, links and structure

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

---------

Co-authored-by: Roger Barreto <[email protected]>
Co-authored-by: Matthew Bolaños <[email protected]>
2024-07-26 15:56:19 +00:00
Dmytro Struk 23f2dcec15 .Net: Filters graduation (#7004)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

Resolves: https://github.com/microsoft/semantic-kernel/issues/5409

1. Removed experimental flags on `FunctionInvocationFilter` and
`PromptRenderFilter`.
2. Updated documentation.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2024-07-08 15:08:17 +00:00
Bruno Borges 656e0eb746 Update README.md (#6574) 2024-06-19 08:46:11 +00:00
Matthew Bolaños f1dab8f8b8 Simplify README.md (#6347)
Simplifying readme until further changes are available.
2024-05-21 22:36:51 +00:00
Evan Mattson 09508dc8ba Python: Restructure samples into new folders to make things more clear. (#6116)
### Motivation and Context

All previous samples were either in kernel syntax or a separate
notebooks folder. The goal is to make the samples easier to understand
and have a better structure.

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

The PR restructures the kernel syntax examples into new folders:
concepts (with subfolders for previous syntax examples), demos,
getting_started, and learn_resources.
- Closes #6119 
- Adds a new concept/function example for understanding kernel
arguments.
- Updates the bookings plugin

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
2024-05-04 11:50:04 +00:00
5c81935980 DOC ONLY: Added a contributor wall of fame to the README (#3381)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
1. Why is this change required? This is not required; it is optional but
is great for community-building.
2. What problem does it solve? It adds an image of the top 100
contributors to the repo near the bottom of the README. Source of dev
pride. :)
3. What scenario does it contribute to? This encourages contributions
and rewards the top 100 contributors.
  4. If it fixes an open issue, please link to the issue here.  N/A
-->
1. Why is this change required? This is not required; it is optional but
is great for community-building.
2. What problem does it solve? It adds an image of the top 100
contributors to the repo near the bottom of the README. Source of dev
pride. :)
3. What scenario does it contribute to? This encourages contributions
and rewards the top 100 contributors.
  4. If it fixes an open issue, please link to the issue here.  N/A

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

Documentation change only

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄

---------

Co-authored-by: Mark Wallace <[email protected]>
Co-authored-by: Weihan Li <[email protected]>
2023-11-17 10:16:59 +00:00
Michelle 263c9c68d4 .Net: Small fixes for C# tutorial (#3449)
### Motivation and Context

A few small fixes to make it easier for those getting started with C#

### Description

* Fix api name in sample code that has changed
* Make it easier for users to install the right package

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-11-10 15:42:38 +00:00
Mark Wallace 1fd1a530ad Update the readme to reference Java in main branch (#3377)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
2023-11-03 19:24:29 +00:00
Devis Lucato ab35598ef4 Update README.md (#3287)
Update docs about Kernel Memory
2023-10-24 12:19:35 -07:00
7677dc0c61 Fix typo in README.md (#2692)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description
projoect -> project
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

Co-authored-by: Dmytro Struk <[email protected]>
Co-authored-by: Lee Miller <[email protected]>
2023-09-05 19:14:25 +00:00
nacharya1 317725efea Update README.md (#2631)
Added comment to promote staring of the repo

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required? Adding callout to star repo
  2. What problem does it solve? understand trending of repo
  3. What scenario does it contribute to? community feedback
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-08-29 19:07:14 +00:00
Matthew Bolaños 2b82637c15 Update readme (#2313)
### Motivation and Context
This update cleans up the initial readme and provides additional links
to documentation and other Semantic Kernel projects.


### Contribution Checklist

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
2023-08-09 14:39:57 +00:00
Matthew Bolaños 54ee340ca2 Python: Move notebooks into language folders (#2368)
### Motivation and Context
In an effort to move all samples to their respective language folder,
I've moved all of the notebooks to the correct language folder.


### Contribution Checklist

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
2023-08-09 14:29:56 +00:00
Mark Wallace 5885b95d00 Add Java to the getting started section (#2110)
### Motivation and Context

Please help reviewers and future users, providing the following
information:
1. Why is this change required? Update the readme to include getting
started information for the Java version.

### Description
Preview the file to see the changes.

### Contribution Checklist

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#dev-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-07-27 16:55:49 +00:00
Matthew Bolaños 39395422b6 Create pointers to learn.microsoft.com (#2159)
### Motivation and Context
To align docs, we should redirect developers to the documents on the
official learn site.

### Description
- Create redirects for docs files in repo that point users to
learn.microsoft.com.
- Update readme links to point to learn.microsoft.com

### Contribution Checklist
- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
2023-07-25 22:41:13 +00:00
Alex ChaoandAlex Chao d454735d5b Python: Update Python README and FEATURE_MATRIX (#2004)
Update the README for Python to include latest notebooks and add a link
to Learn Documentation site for the feature matrix

---------

Co-authored-by: Alex Chao <achao@achao>
2023-07-17 16:42:03 +00:00
MixeroTN 69fb41131d Improve README.md (#1870)
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

`README.md` had several visual problems, which I decided to fix.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

- The first problem was a `dotnet-ci` status badge, which is no longer
available. I replaced it with two status badges: `dotnet-ci-docker` and
`dotnet-ci-windows`.
- The second one was *Using Semantic Kernel in C# and Python*. The icons
were positioned out of place. I have made a small table with the icons
and hyperlinks present earlier.
- And finally, small corrections such as h3 lines for C# and Python
approaches above *getting started with the basics* instructions.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
2023-07-06 16:27:36 +00:00
527d3782f8 [README] Add community calendar link to the main README (#1662)
Adding the SK Community calendar to the main README for office hours and
community events

### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->


### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->


### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [ ] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

---------

Co-authored-by: Alex Chao <achao@achao>
Co-authored-by: Shawn Callegari <[email protected]>
2023-06-25 23:05:11 +00:00
nacharya1 e874fe767a Update to main readme to add SK Deploy to Azure as Web App (#1184) 2023-05-23 11:14:10 -07:00
Shawn Callegari c0ab238f58 Azure Functions net7.0 Support (#1126)
### Description
KernelHttpServer Azure Functions project targets net6.0. Building with
net7.0 SDK succeeds, but then running it in an environment with only a
net7.0 runtime installed fails, as it requires the net6.0 runtime to
boot.

With this change, we apply the `<RollForward>LatestMajor</RollForward>`
MSBuild tag to the KernelHttpServer csproj file. This instructs the
project to target the highest version of dotnet installed (min net6.0).
2023-05-22 14:36:58 -07:00
nacharya1andHarleen Thind e33e195ad4 Updates to main readme to remove top image and add call outs for plug-ins (#1155)
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required? Removed outdates top image
2. What problem does it solve? not giving readers inaccurate information
3. What scenario does it contribute to? new developers learning about SK
  4. If it fixes an open issue, please link to the issue here.
-->


### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
N/A

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Harleen Thind <[email protected]>
2023-05-22 19:38:51 +00:00
Vivien Hung f627566907 Fix Yarn link and add QnA in CopilotChat (#1124)
### Motivation and Context
Copilot Chat uses packages that can only be supported by Yarn v1.x.
However, we have multiple reported cases where customers follow the
instructions to install the wrong version of Yarn that causes errors in
the Copilot Chat app.


### Description
1. Update the Semantic Kernel top README to use classic Yarn
installation link.
2. Add Troubleshooting guidance for Yarn 2.x+ in Copilot Chat README.


### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
~- [ ] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`~
~- [ ] All unit tests pass, and I have added new tests where possible~
- [x] I didn't break anyone 😄
2023-05-19 20:56:33 -07:00
nacharya1andHarleen Thind fa9d388fe5 Update to Readme.MD Note (#1068)
### Motivation and Context
<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
1. Why is this change required? Update to notice due to the evolution of
this project
2. What problem does it solve? Notice to inform that Semantic Kernel
will continue to evolve rapidly
3. What scenario does it contribute to? Sets precedent of current status
of project and on-going changes in velocity.
  4. If it fixes an open issue, please link to the issue here.
-->


### Description
<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
Changes to update main readme.md notice.

### Contribution Checklist
<!-- Before submitting this PR, please make sure: -->
- [x] The code builds clean without any errors or warnings
- [x] The PR follows SK Contribution Guidelines
(https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
- [x] The code follows the .NET coding conventions
(https://learn.microsoft.com/dotnet/csharp/fundamentals/coding-style/coding-conventions)
verified with `dotnet format`
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

Co-authored-by: Harleen Thind <[email protected]>
2023-05-18 18:16:08 +00:00
Devis Lucato e8cca62c7a Update packages' and planning docs (#852)
* Fix #735: broken links in pip README. Sync nuget and pip readmes.
* Update planning doc, use plural for "planners".
* Add RAG to list of patterns supported by SK.
2023-05-08 00:39:38 -07:00
Abby Harrison c2b3a6bf7a Feature matrix improvements (#509)
### Motivation and Context
With the official publishing of the Python Semantic Kernel, we should be
informing the public of feature parity between Python and C#. Python is
currently playing catch up.


### Description
Removed the FEATURE_PARITY.md file from the python directory and added a
FEATURE_MATRIX.md file to the top level of the repo. The main REAME.md
now links to this file. Added a stronger breakdown of features that we
are tracking for SK.
2023-04-18 23:41:26 -07:00
lightningRalf 1b9efa954e changed name_of_button+discord_logo+color (#498)
### Motivation and Context
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?                 -> more consistancy
2. What problem does it solve? -> make it clear on the button that
discord is used
  3. What scenario does it contribute to?     -> visibility of discord

### Description
- changed name of button
  + the color to match it with the 'Kernel' color.
  + added discord logo
2023-04-18 14:36:08 +00:00
Devis Lucato b2be938e4f Fix typos and improve docs (#447)
### Motivation and Context

Fix typos and improve docs.
2023-04-13 17:43:34 -07:00
Devis Lucato e2e5e2dad3 Python: docs update + ruff config + fix tests 2023-04-13 16:12:36 -07:00
Devis Lucato 5fc05b2bea * Update notebooks to use pip package
* Add python getting started notebook
* Fix notebooks usage of Azure text completion
* Fix bug with skills definition
* Update READMEs
* New release version 0.2.2
2023-04-13 16:12:36 -07:00
d4335a7518 Update README.md (#399)
Updated readme to include Copilot Chat.

---------

Co-authored-by: Devis Lucato <[email protected]>
Co-authored-by: Devis Lucato <[email protected]>
Co-authored-by: Adrian Bonar <[email protected]>
2023-04-12 12:37:29 -07:00
Devis Lucato 0d9727a385 Update readme (#376)
Change code example, fix typo, reduce lenght
2023-04-09 17:40:30 -07:00
Devis Lucato 43bc6f5452 Sync README with nuget (#327)
Update README with latest syntax from new nuget
2023-04-04 22:18:44 +00:00