docs: added formatted README with screenshots and improved structure (issue #8) - #11
Open
anjanakri wants to merge 5 commits into
Open
docs: added formatted README with screenshots and improved structure (issue #8)#11anjanakri wants to merge 5 commits into
anjanakri wants to merge 5 commits into
Conversation
anjanakri
changed the title
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the README to be more structured and informative, with clearer sections for architecture, tech stack, workflow, setup, and contribution guidance.
Changes:
- Reformatted the README with consistent Markdown headings, separators, and a new Table of Contents.
- Replaced narrative tech stack sections with purpose-driven tables and clarified workflow steps.
- Added screenshots and expanded setup/deployment/contributing instructions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+70
to
+73
| | Technology | Purpose | | ||
| |------------|---------| | ||
| | React.js | Fast UI rendering and seamless Web3 integration | | ||
| | Vercel | Serverless, scalable hosting | |
Comment on lines
+132
to
+139
|  | ||
|
|
||
| --- | ||
|
|
||
| ### Admin Dashboard | ||
| *Platform dashboard for managing donors, patients, pledges, and transplant matching* | ||
|
|
||
|  |
Comment on lines
+132
to
+139
|  | ||
|
|
||
| --- | ||
|
|
||
| ### Admin Dashboard | ||
| *Platform dashboard for managing donors, patients, pledges, and transplant matching* | ||
|
|
||
|  |
| - Ganache | ||
| - MetaMask browser extension | ||
|
|
||
| ### Clone the Repository |
|
|
||
| --- | ||
|
|
||
| ## Screenshots |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
anjanakri
marked this pull request as draft
May 27, 2026 10:40
Updated language for clarity and consistency throughout the README. Added sections on project features, setup instructions, and future scope.
Comment on lines
+78
to
+81
| | Technology | Purpose | | ||
| |------------|---------| | ||
| | React.js | Fast and responsive user interface | | ||
| | Vercel | Scalable frontend hosting | |
| *Public-facing landing page with organ donation awareness and pledge CTA* | ||
|
|
||
| * Smart contract stores: | ||
|  |
|
|
||
| * Fetch CID from blockchain | ||
| * Retrieve file from IPFS securely | ||
|  |
| - [Comparison with Traditional Systems](#comparison-with-traditional-systems) | ||
| - [Limitations](#limitations) | ||
| - [Future Scope](#future-scope) | ||
| - [Contributing](#contributing) |
Comment on lines
+253
to
+255
| ## Environment Variables | ||
|
|
||
| Create a `.env` file where required. |
| ``` | ||
| organchain/ | ||
| ```text | ||
| Organ_BlockChain/ |
| ```bash | ||
| git clone https://github.com/ffrazi/organchain.git | ||
| cd organchain | ||
| git clone https://github.com/jaideep005/Organ_BlockChain.git |
Author
|
Hey Admin @jaideep005, kindly review this PR. This PR fixes issue #8 that you assigned. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jaideep005
marked this pull request as ready for review
June 2, 2026 04:19
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
Restructured and formatted the README.md for improved readability, consistency, and visual appeal. Added project screenshots and enhanced documentation clarity.
Fixes/Related Issue
Fixes #8
🎯 Changes Made
Structure & Formatting
>>,->,🔹)Visual Enhancements
Content Improvements
Files Changed
README.md— Complete restructure and enhancementscreenshot_homepage.png— Platform landing page (NEW)screenshot_dashboard.png— Admin dashboard interface (NEW)🔍 Why This Matters
✅ Testing
📋 Checklist
##Screenshots