docs: restructure README and add backend README - #115
Merged
DenizAltunkapan merged 2 commits intoAug 5, 2026
Conversation
Kanishkamangal09
requested review from
GabrielBBaldez and
MaximilianRau04
as code owners
August 5, 2026 08:29
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures project documentation by slimming down the root README.md into a high-level entry point and moving backend-specific feature and setup documentation into a new backend/README.md, aligning with the goals in issue #113.
Changes:
- Simplified root README to focus on ecosystem orientation, quick start, and links to deeper docs.
- Added
backend/README.mdcontaining backend responsibilities, feature details, and local development guidance. - Centralized detailed documentation to reduce duplication and keep instructions in one place.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| README.md | Reduced to an entry-point README with feature bullets, quick start, and dependency overview linking to backend docs |
| backend/README.md | New backend-focused README with responsibilities, feature/API details, and local dev + test instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
DenizAltunkapan
approved these changes
Aug 5, 2026
DenizAltunkapan
left a comment
Member
There was a problem hiding this comment.
@Kanishkamangal09 thank you for your contribution
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
Summary
This PR restructures the project documentation by simplifying the root README and moving backend specific documentation into a new
backend/README.md.Changes
backend/README.mdfor backend specific documentation.Closes #113