Move development setup documentation from README to dedicated getting started guide #792
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tarted.md Co-authored-by: BenjaminMichaelis <[email protected]>
Copilot
AI
changed the title
[WIP] There are some Ad hoc notes and documentation at the bottom of the readme that is really only useful for development. Move this to a getting started.md file in the docs folder
Move development setup documentation from README to dedicated getting started guide
Oct 3, 2025
Copilot finished work on behalf of
BenjaminMichaelis
October 3, 2025 10:09
BenjaminMichaelis
approved these changes
Oct 3, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the repository documentation by moving development-specific content from the main README.md to a new dedicated getting started guide for improved documentation structure and developer onboarding.
- Created a new documentation structure with
docs/folder and comprehensive getting started guide - Simplified the main README to focus on project overview rather than detailed setup instructions
- Improved organization of development environment setup information
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/getting-started.md | New comprehensive development setup guide with prerequisites, startup steps, and environment configuration |
| README.md | Simplified to focus on project overview with reference to getting started guide |
BenjaminMichaelis
deleted the
copilot/fix-1451f9d3-afb5-4232-b302-a6add5e7d191
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR reorganizes the repository documentation by moving development-specific content from the main README.md to a new dedicated getting started guide.
Problem
The README.md contained ad hoc notes and detailed development setup instructions at the bottom that were primarily useful for developers setting up their local environment. This made the README longer than necessary and mixed high-level project information with detailed setup instructions.
Solution
docs/folder to house documentationdocs/getting-started.mdwith comprehensive development setup instructions including:Benefits
Closes the issue requesting separation of development notes from the main README.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.