Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[repo] docs: revamp getting started docs #1127

Merged
merged 73 commits into from
Jan 8, 2024
Merged

[repo] docs: revamp getting started docs #1127

merged 73 commits into from
Jan 8, 2024

Conversation

singhk97
Copy link
Collaborator

@singhk97 singhk97 commented Jan 5, 2024

Linked issues

closes: #733 #1126 #732 (issue number)

Adding: @corinagum, @Carter425 as contributors since I rephrased and relocated docs written by them.

Details

Added the following sections

  • Overview - Introduction to the getting started docs
  • Quickstart - Step by step instructions to get the echo bot set up.
  • Samples - Overview of all the samples in the sdk and supported language.
  • Migration (Overview, JS, C#) - How to migrate a BF SDK app to Teams AI app.

Tweaked the following sections

  • C#, JS package readme's migration section has been merged into the getting started docs
  • Samples folder readme now points to the getting started docs "sample" section.

Removed the following sections from the existing getting started docs

  • dotnet/*
  • js/*
  • 00.PROMPTs - 05.TURNS
  • README.md (replaced by 00.OVERVIEW.md)

Attestation Checklist

  • My code follows the style guidelines of this project

  • I have checked for/fixed spelling, linting, and other errors

  • I have commented my code for clarity

  • I have made corresponding changes to the documentation (we use TypeDoc to document our code)

  • My changes generate no new warnings

  • I have added tests that validates my changes, and provides sufficient test coverage. I have tested with:

    • Local testing
    • E2E testing in Teams
  • New and existing unit tests pass locally with my changes

@singhk97
Copy link
Collaborator Author

singhk97 commented Jan 8, 2024

I see that we are removing the docs that introduce/explain to developers our different concepts in the SDK, is this somewhere else now? For many people using the SDK it will be their first time interacting with AI so I think its important for us to explain what our different concepts are and how they contribute to the greater whole.

Agreed. We will continue to add docs in the coming weeks.

@singhk97
Copy link
Collaborator Author

singhk97 commented Jan 8, 2024

LGTM - approving, but please address what we discussed in call:

  1. I think having 'under construction' sections for content that is out of date is okay, but let's not 100% delete stuff like turns and actions, etc. Just in case it takes a while to circle back to that content, I'd rather not lose it.
  2. Asking Carter to look through everything in a 'new to the repo' context for sanity / organization comments.
  3. Matching JS directions to DOTNET re: directions on running the sample in one location.
  1. I've added Turns guide. As for actions...etc and concepts related to the AI system I would need more time to carefully rewrite. Even though it's deleted, it still lives in the commit history so we can always go back and retrieve it.
  2. I like this idea. Will ask him.
  3. I didn't match is 100% per se but made it very similar.

@corinagum corinagum merged commit fc320ea into main Jan 8, 2024
6 checks passed
@corinagum corinagum deleted the kavin/docs-revamp branch January 8, 2024 23:20
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.

[getting started docs] Migration from BF SDK (C# & JS)
4 participants