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 the README #1585

Open
2 tasks
gulfaraz opened this issue Sep 16, 2024 · 0 comments
Open
2 tasks

Update the README #1585

gulfaraz opened this issue Sep 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation InDevOps Issue copy-pasted to Microsoft DevOps

Comments

@gulfaraz
Copy link
Member

gulfaraz commented Sep 16, 2024

Who requested this task

@gulfaraz

Request

Update the README to remove outdated docs, move details to the wiki, and simplify so the first read is easy for a newcomer.
The readme should serve as a table of contents to the reader and not a knowledge dump.

User Story

As a external dev
I want to see an itemized and updated readme
So that I find the correct route for my purpose (whatever that may be)

Acceptance Criteria

Describe when the expected output of this spike should be accepted.

  • Review with the other devs
  • Show and tell during sprint review

Timebox

16 hours before re-evaluating with the team if more time is needed.

Additional Context

Examples for inspiration - Angular, React, and VS Code

@gulfaraz gulfaraz added documentation Improvements or additions to documentation refine This issue is ready for refinement labels Sep 16, 2024
@diderikvw diderikvw removed the refine This issue is ready for refinement label Sep 17, 2024
@gulfaraz gulfaraz added this to the Quality Assurance milestone Sep 30, 2024
@gulfaraz gulfaraz changed the title [SPIKE] Update the README [Task] Update the README Oct 15, 2024
@diderikvw diderikvw changed the title [Task] Update the README Update the README Oct 24, 2024
@diderikvw diderikvw added the InDevOps Issue copy-pasted to Microsoft DevOps label Dec 2, 2024
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 InDevOps Issue copy-pasted to Microsoft DevOps
Projects
None yet
Development

No branches or pull requests

2 participants