Skip to content

Update READMEs to add details on building playground and katas#1402

Merged
tcNickolas merged 12 commits into
microsoft:mainfrom
Manvi-Agrawal:manvi/update-readme
Apr 18, 2024
Merged

Update READMEs to add details on building playground and katas#1402
tcNickolas merged 12 commits into
microsoft:mainfrom
Manvi-Agrawal:manvi/update-readme

Conversation

@Manvi-Agrawal
Copy link
Copy Markdown
Contributor

@Manvi-Agrawal Manvi-Agrawal commented Apr 18, 2024

Add instructions about building katas locally by building playground

Comment thread katas/README.md
@Manvi-Agrawal
Copy link
Copy Markdown
Contributor Author

@tcNickolas need advice on following points:

  1. Do you think we should have a README for samples folder? Currently, I don't see any README there.
  2. How about a short section of how to migrate katas from old repository to the new one? I think following things will help:
  • Sample PR
  • Dont include images for now, since they need redesign.
  • Look out for API name changes, if any.
  • Change link to new QDK documentation.
  • Get away with relative links for mentioning other katas or previous tasks, describe the things instead

@Manvi-Agrawal Manvi-Agrawal marked this pull request as ready for review April 18, 2024 05:47
Copy link
Copy Markdown
Contributor

@tcNickolas tcNickolas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I suggested a few small edits.

Thank you!

Comment thread README.md Outdated
Comment thread katas/README.md Outdated
Comment thread katas/README.md Outdated
@tcNickolas
Copy link
Copy Markdown
Contributor

@tcNickolas need advice on following points:

  1. Do you think we should have a README for samples folder? Currently, I don't see any README there.
  2. How about a short section of how to migrate katas from old repository to the new one? I think following things will help:
  1. I would not add it for now - the samples folder is rather self-descriptive and doesn't have any special build instructions or knowledge associated with it. The one sub-folder that is a bit trickier to navigate is estimation, but that one already has its own readme with more details about different samples.

  2. Katas migration is going to be a very short endeavor - the Classic QDK is going to be deprecated in June, so we need to complete migration in about two months. (Plus a lot of katas will need a much more significant rework than that, some even won't be migrated.) So I wouldn't elaborate on it in the readme - the readme should focus on using the new katas and developing them, not on getting them from one specific source.

This information can be good to add to the migration issue, since it is focused specifically on migration and will be closed once that's complete.

Manvi-Agrawal and others added 3 commits April 18, 2024 08:54
Co-authored-by: Mariia Mykhailova <michaylova@gmail.com>
Co-authored-by: Mariia Mykhailova <michaylova@gmail.com>
Copy link
Copy Markdown
Contributor

@tcNickolas tcNickolas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, we just need somebody who's an owner of the whole repo to sign off too

Comment thread README.md Outdated
Comment thread katas/README.md Outdated
@tcNickolas
Copy link
Copy Markdown
Contributor

Urgh, looks like Prettier is not happy with one of the files, can you take a look to fix? Probably a missing newline somewhere

Comment thread README.md Outdated
Comment thread playground/README.md Outdated
Comment thread playground/README.md
Manvi-Agrawal and others added 3 commits April 18, 2024 11:38
Co-authored-by: Mine Starks <16928427+minestarks@users.noreply.github.com>
Co-authored-by: Mine Starks <16928427+minestarks@users.noreply.github.com>
Co-authored-by: Mine Starks <16928427+minestarks@users.noreply.github.com>
@Manvi-Agrawal
Copy link
Copy Markdown
Contributor Author

Manvi-Agrawal commented Apr 18, 2024

Todo: update hyperlinks because of header change

PS: Done

@Manvi-Agrawal
Copy link
Copy Markdown
Contributor Author

Manvi-Agrawal commented Apr 18, 2024

Urgh, looks like Prettier is not happy with one of the files, can you take a look to fix? Probably a missing newline somewhere.

Done

@minestarks
Copy link
Copy Markdown
Member

Thank you for the updates!

@tcNickolas tcNickolas changed the title [Katas] Update README to build katas [Katas] Update READMEs to add details on building playground and katas Apr 18, 2024
@tcNickolas tcNickolas changed the title [Katas] Update READMEs to add details on building playground and katas Update READMEs to add details on building playground and katas Apr 18, 2024
@tcNickolas tcNickolas added this pull request to the merge queue Apr 18, 2024
Merged via the queue into microsoft:main with commit 5e95737 Apr 18, 2024
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.

3 participants