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

Update sub-readmes for getting started #345

Merged
merged 6 commits into from
Sep 13, 2023

Conversation

momuno
Copy link
Member

@momuno momuno commented Sep 13, 2023

Motivation and Context

  1. Why is this change required? Confusion on getting-started abounds!
  2. What problem does it solve? sub-readmes provided inconsistent basic getting-started info.
  3. What scenario does it contribute to? attempting to remove confusion around getting started
  4. If it fixes an open issue, please link to the issue here. Chat Copilot getting-started readme cleanup #344

Description

This removes duplicate or incomplete information from the sub-readmes in webapp/ and webapi/ on basic getting started. It redirects users to the main instruction readme, and also points to the learn docs getting started guide (which should be the ONLY duplicate of these instructions).

This change does NOT:

  • attempt to update detailed development or debug information on the backend. That falls under a separate task.
  • attempt to update the optional material. This pre-existing material has not been tested and any updates fall under a separate task.

Therefore, there is an added "under development" section in the sub-readmes to alert readers on potentially remaining out-of-date material.

Contribution Checklist

@github-actions github-actions bot added documentation Improvements or additions to documentation webapi Pull requests that update .net code PR: ready for review labels Sep 13, 2023
@momuno momuno changed the title Initial changes for webapi readme Update sub-readmes for getting started Sep 13, 2023
@github-actions github-actions bot added the webapp Pull requests that update Typescript code label Sep 13, 2023
@momuno momuno marked this pull request as ready for review September 13, 2023 18:12
@momuno momuno added this pull request to the merge queue Sep 13, 2023
Merged via the queue into microsoft:main with commit 723ec63 Sep 13, 2023
8 checks passed
@momuno momuno deleted the dev/readme-instruction-guide-cleanup branch September 13, 2023 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation webapi Pull requests that update .net code webapp Pull requests that update Typescript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants