Problem Statement
Problem 1: The README is missing a "Getting Started" section and does not reference docs/RunApplication.md for new users.
Problem 2: The README references a contributor guide (CONTRIBUTING.md) that does not exist (404 error).
- Discussion needed: How should we handle contributor guidance? Options could include:
- Creating a proper CONTRIBUTING.md file
- Removing the reference and directing to Code of Conduct
- Adding inline guidance in README
- Other approaches?
Problem 3: The docs/RunApplication.md file could be improved by:
- Explicitly stating the repository name (AzDevOpsDemoGenerator)
- Specifying the solution file path (src/ADOGenerator.sln) in the steps
- Providing actual GitHub URL instead of placeholders
Proposed Solution
For Problems 1 & 3: Surgical PRs with specific fixes
- Add Getting Started section to README, referencing
docs/RunApplication.md
- Edit
docs/RunApplication.md with explicit repo name and correct solution path
Problem 2 requires community discussion on the best approach.
Implementation Status
References
Note: This issue tracks multiple related documentation improvements. Individual PRs will reference this issue to prevent duplicate work.
Problem Statement
Problem 1: The README is missing a "Getting Started" section and does not reference
docs/RunApplication.mdfor new users.Problem 2: The README references a contributor guide (CONTRIBUTING.md) that does not exist (404 error).
Problem 3: The
docs/RunApplication.mdfile could be improved by:Proposed Solution
For Problems 1 & 3: Surgical PRs with specific fixes
docs/RunApplication.mddocs/RunApplication.mdwith explicit repo name and correct solution pathProblem 2 requires community discussion on the best approach.
Implementation Status
References
Note: This issue tracks multiple related documentation improvements. Individual PRs will reference this issue to prevent duplicate work.