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.

Sign up for GitHub

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

Jump to bottom

[C#] Revamp getting started docs #732

Closed
2 tasks done
Tracked by #1100
, #824
...
singhk97 opened this issue Oct 25, 2023 · 0 comments
Closed
2 tasks done
Tracked by #1100
, #824
...

[C#] Revamp getting started docs #732

singhk97 opened this issue Oct 25, 2023 · 0 comments
Assignees
@singhk97
Labels
documentation Improvements or additions to documentation dotnet Change/fix applies to dotnet. If all three, use the 'JS & dotnet & Python' label medium tshirt size medium (5-10 days)

Comments

@singhk97
Copy link
Collaborator

singhk97 commented Oct 25, 2023 •
edited
Loading

Tasks
Preview Give feedback
  1. [getting started docs] Migration from BF SDK (C# & JS) #733
    documentation dotnet parity small
    Carter425 corinagum
    singhk97
  2. [getting started docs] Overview, Quickstart & Samples #1126
    corinagum singhk97
@singhk97 singhk97 mentioned this issue Oct 25, 2023
Closed
@corinagum corinagum added documentation Improvements or additions to documentation dotnet Change/fix applies to dotnet. If all three, use the 'JS & dotnet & Python' label labels Dec 6, 2023
@singhk97 singhk97 closed this as not planned Won't fix, can't repro, duplicate, stale Dec 7, 2023
@singhk97 singhk97 reopened this Dec 7, 2023
@singhk97 singhk97 mentioned this issue Dec 8, 2023
Open
@singhk97 singhk97 self-assigned this Dec 14, 2023
@aacebo aacebo mentioned this issue Dec 21, 2023
Closed
@aacebo aacebo added the medium tshirt size medium (5-10 days) label Dec 27, 2023
@singhk97 singhk97 changed the title [C#] Update getting started docs [C#] Revamp getting started docs Jan 4, 2024
@singhk97 singhk97 mentioned this issue Jan 5, 2024
Merged
1 task
corinagum pushed a commit that referenced this issue Jan 8, 2024
@singhk97
[repo] docs: revamp getting started docs (#1127)
fc320ea 
## 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

- [x] 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](https://typedoc.org/) 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 singhk97 closed this as completed Jan 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@singhk97 singhk97

Labels
documentation Improvements or additions to documentation dotnet Change/fix applies to dotnet. If all three, use the 'JS & dotnet & Python' label medium tshirt size medium (5-10 days)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@corinagum @aacebo @singhk97