{"id":569,"date":"2023-06-21T13:54:40","date_gmt":"2023-06-21T20:54:40","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/semantic-kernel\/?p=569"},"modified":"2023-06-21T13:56:32","modified_gmt":"2023-06-21T20:56:32","slug":"say-hello-to-the-updated-semantic-kernel-docs","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/agent-framework\/say-hello-to-the-updated-semantic-kernel-docs\/","title":{"rendered":"Say hello to the updated Semantic Kernel docs!"},"content":{"rendered":"

\"Image<\/a><\/h2>\n

We’ve heard the community loud and clear: you want better documentation for Semantic Kernel. Today, we’re excited to announce that we’ve completely revamped our Learn site<\/a> to make it easier for you to learn about Semantic Kernel and to get started using it.<\/p>\n

What’s new?<\/h2>\n

We have a lot of new content for you to explore that we believe will make it easier for you to get started with Semantic Kernel, whether you use C#\u00a0or<\/em> Python. Our updated content also does a better job describing how Semantic Kernel fits in with the rest of the Microsoft ecosystem and other applications like ChatGPT.<\/p>\n

\"Image<\/a>1) Get to know plugins<\/h3>\n

One of the biggest pieces of news from Build was Microsoft’s alignment with ChatGPT’s plugins. Many of you in the community have been interested in learning how that impacts Semantic Kernel.<\/p>\n

We’ve added a new section to our docs that explains how plugins work<\/a>, how you can use them with Semantic Kernel, and our plans to converge with the ChatGPT plugin model<\/a>.<\/p>\n

2) Python samples everywhere<\/em><\/h3>\n

\"Image<\/a>We\u2019re hard at work creating parity between the .NET and Python flavors of the SDK, but if you had looked at our docs earlier, it was difficult to figure out how to use the Python SDK.<\/p>\n

With the updates, we’ve added Python samples to nearly every tutorial and sample in the docs.<\/p>\n

3) New tutorials and samples<\/h3>\n

As part of this update, we also wanted to provide tutorials that were more relevant to what the community was building, so in the Orchestrating AI plugins<\/a> section of the docs, we walk you through how to build an AI app with plugins from beginning to end.<\/p>\n

    \n
  1. Start by learning about semantic functions<\/a> to derive intent.<\/li>\n
  2. Give your AI the power of computation with native functions<\/a>.<\/li>\n
  3. Chain functions together<\/a> to get the best of AI and native code.<\/li>\n
  4. And finally use planner to automatically generate a plan<\/a>\u00a0with AI.<\/li>\n<\/ol>\n

    By the end of the tutorials, you’ll have built an app that can take a user’s input, derive intent, and then automatically generate a plan to execute the user’s request.<\/p>\n

    We know following line-by-line in documentation can be a bit tedious, so we’ve also provided completed solutions for each of the doc articles in both C#<\/a> and Python<\/a> flavors.<\/p>\n

    4) Create issues on the docs<\/h3>\n

    Finally, we’ve moved our entire doc site to a public GitHub repo<\/a>. This means that you can now create issues on the docs themselves. If you see something that’s confusing or incorrect, please let us know by creating an issue<\/a> on the docs repo. We’ll also accept PRs if you want to make the change yourself.<\/p>\n

    But don’t feel limited to just creating issues for problems with the docs. If you have any feedback on how we can make the docs better, please let us know! Whether that’s new sections, how-to guides, videos, or even just a new sample, we want to hear from you.<\/p>\n

    And in case you missed it…<\/h2>\n

    There are several other great resources we recently added to the docs that we wanted to highlight just in case you missed them.<\/p>\n

    5) Leverage our hackathon materials<\/h3>\n

    \"Image<\/a>Learning about Semantic Kernel is very popular right now. One of the best ways to learn is by hacking together with others.<\/p>\n

    We’ve created a kit of hackathon materials<\/a> that you can use to host your own hackathon. The materials includes a sample agenda, prerequisites, and a presentation.<\/p>\n

    6) Learn more with in-depth tutorials<\/h3>\n

    \"Image<\/a>Additionally, we’ve created a page that highlights some of the best in-depth tutorials<\/a> that we’ve seen created. These tutorials walk you through how to build a full app from beginning to end.<\/p>\n

    If you think we’ve missed a great tutorial, please let us know by creating an issue<\/a>\u00a0or submitting a pull request with a link to the tutorial.<\/p>\n

    We’re not done yet!<\/h2>\n

    We’re excited about sharing the new docs, but we’re definitely not done yet. Keep an eye out for even more updates in the future. Here are some of the things we’re working on.<\/p>\n

    SDK reference docs<\/h3>\n

    Today, to know how the SDK works, you need to read the source code. We’re working on creating reference docs for the .NET and Python SDK so that you can easily see what each class and method does on the Learn site. Below is a preview of what the reference docs will look like once they’re complete.<\/p>\n

    \"Image<\/a><\/p>\n

    Publicly available backlog<\/h3>\n

    We also want to be more transparent about what we’re working on and what’s coming next for our docs. We’re working on creating a public project in GitHub so you can see what we’re actively working on in the docs. Until then, here’s a preview of what the backlog will look like with a sneak peek at some of the additions we’re planning.<\/p>\n

    \"Image<\/a><\/p>\n

    More great content<\/h3>\n

    And last, but not least, we’re working on creating more great content for the docs! We want to create additional explainers with code samples on memory, authentication, Copilot chat, and more. But most importantly, we want to hear from you. What do you want to see next? Let us know by creating an issue<\/a> or letting us know in our Discord server<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"

    We’ve heard the community loud and clear: you want better documentation for Semantic Kernel. Today, we’re excited to announce that we’ve completely revamped our Learn site to make it easier for you to learn about Semantic Kernel and to get started using it. What’s new? We have a lot of new content for you to […]<\/p>\n","protected":false},"author":121401,"featured_media":633,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-569","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-semantic-kernel"],"acf":[],"blog_post_summary":"

    We’ve heard the community loud and clear: you want better documentation for Semantic Kernel. Today, we’re excited to announce that we’ve completely revamped our Learn site to make it easier for you to learn about Semantic Kernel and to get started using it. What’s new? We have a lot of new content for you to […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts\/569","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/users\/121401"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/comments?post=569"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts\/569\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/media\/633"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/media?parent=569"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/categories?post=569"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/tags?post=569"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}