Skip to content
This repository was archived by the owner on Jul 21, 2025. It is now read-only.
This repository was archived by the owner on Jul 21, 2025. It is now read-only.

Add Getting Started Section to README and Improve docs/RunApplication.md Instructions #66

@aymanaboghonim

Description

@aymanaboghonim

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

  1. Add Getting Started section to README, referencing docs/RunApplication.md
  2. Edit docs/RunApplication.md with explicit repo name and correct solution path

Problem 2 requires community discussion on the best approach.

Implementation Status

  • Problem 1: Add Getting Started section to README
  • Problem 3: Improve docs/RunApplication.md instructions
  • Problem 2: Discussion thread for CONTRIBUTING.md approach

References


Note: This issue tracks multiple related documentation improvements. Individual PRs will reference this issue to prevent duplicate work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions