Skip to content

Documentation: Updated Readme.md file for GSSoC'25 compliance#1095

Merged
madhukalita merged 4 commits into
codeaashu:mainfrom
DivyaJain-DataAnalyst:main
Aug 9, 2025
Merged

Documentation: Updated Readme.md file for GSSoC'25 compliance#1095
madhukalita merged 4 commits into
codeaashu:mainfrom
DivyaJain-DataAnalyst:main

Conversation

@DivyaJain-DataAnalyst
Copy link
Copy Markdown
Contributor

📌 What does this PR do?

Description

Added an expandable directory structure visualization to the README.md file to help new contributors understand the project layout. Implemented using HTML <details> tag with proper Markdown formatting.

Related Issues

Fixed #1081

Changes Proposed

  • Added interactive folder structure section in README.md
  • Fixed Markdown formatting issues with the collapsible section
  • Included proper indentation for the directory tree
  • Added descriptive comments for each major directory

Checklist

  • I have read and followed the Contribution Guidelines.
  • All new and existing tests passed.
  • I have updated the documentation to reflect the changes I've made.
  • My code follows the code style of this project.
  • The title of my pull request is a short description of the requested changes.

Screenshots

1
2
3

Note to reviewers

  1. 🔍 Functionality
  • Collapsible section works in both desktop and mobile views
  • Directory structure accurately reflects current project state
  • No broken links or incorrect file paths (needs verification)
  1. 📝 Documentation Quality
  • Comments are clear and helpful for new contributors
  • Structure is logically organized
  • No sensitive files accidentally exposed
  1. 🎨 Style Consistency
  • Follows project's Markdown conventions
  • Proper indentation in directory tree
  • Consistent emoji/icon usage
  1. 🚦 Testing Performed

  2. Viewed the README in:

    • GitHub web interface
    • GitHub mobile app
    • VS Code Markdown preview (not tested)
  3. Verified different screen widths:

    • Desktop (≥1024px)
    • Tablet (768px)
    • Mobile (≤480px)
  4. 💡 Pending Decisions

  • Should we add more detail to any directory descriptions?
  • Would a visual diagram (Mermaid/SVG) complement this?
  • Any concerns about maintenance as the project grows?
  1. 📌 Remaining Tasks
  • Add screenshot of rendered view
  • Get confirmation from @Docs-Team

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@vercel
Copy link
Copy Markdown

vercel Bot commented Aug 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
devdisplay ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 8, 2025 6:19am

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Incredible work, @DivyaJain-DataAnalyst! 🚀

🔥 Welcome to DevDisplay — A space where developers and all the tech enthusiasts can connect, collaborate, code, create, and conquer in the tech ecosystem.

At DevDisplay, we don't just welcome contributors—we celebrate them! 🎊 Because here, your ideas matter. Your code matters. You matter. 🚀

💡 This isn't just about adding your profile. It's about making an impact, showcasing your skills, and standing out in the developer ecosystem.

Think of DevDisplay as your own project, not just another open-source contribution. We're not just a platform—we're a global movement redefining the tech space. Our vision is to be the go-to platform for developers and tech enthusiasts worldwide.

🚀 Innovation has no limits!
We encourage you to think beyond the ordinary. Got a revolutionary idea? Spot a gap in the tech world? DevDisplay can be the solution! We want contributors like you to dream big, build bold, and bring game-changing features to life.

🌍 DevDisplay is more than an open-source project. It's a global tech hub, a thriving community, and a platform where you can connect, collaborate, code, create, and conquer.

🔥 Keep pushing boundaries—we're just getting started!
If you put your 💯 into creating something exceptional, you could even join our Global Core Team and also you can lead DevDisplay as a Community Leader in your area, college, or university.


💡 Your issue is now in review!

  • Our maintainers will soon review your PR and provide feedback/suggestions. 🚀 Stay tuned, stay engaged, and get ready to bring your ideas to life! 💡

---

📢 Have ideas to improve DevDisplay? Let us know! We're always looking for innovative minds to shape the future of tech.

💬 Join the conversation. Grow with the community. You belong here. 🙌


📢 Join Our Global Developer Communities & Connect with Innovators:

📩 Need Help? Reach Out to the Team:

💻 Follow DevDisplay on Social Media & Stay Updated:

🔥 🌟 Thank You for Being Here!

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 8, 2025

Hi there! This issue is still open. We are looking forward to your response.
Assignees: None

@DivyaJain-DataAnalyst
Copy link
Copy Markdown
Contributor Author

will it be merged @codeaashu
please merge it.. I need this

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 9, 2025

Hi there! This issue is still open. We are looking forward to your response.
Assignees: None

@madhukalita madhukalita self-requested a review August 9, 2025 10:40
@madhukalita madhukalita added DevDisplay 🌟 This label recognizes every contributor to the DevDisplay Community for their support...💌 Dev Enhancer 🌟 Label 2 for second-time contributors who enhancing and refining features of DevDisplay. 🔧 GSSoC Label for our valued contributors of 🌟 GSSoC '25 GSSoC'25 Label is used for Issues and pull request related to GSSoC 2025 open source contribution. Level 2 - GSSoC '25 Dev Enhancer - Refine and enhance the DevDisplay Platform. labels Aug 9, 2025
@madhukalita
Copy link
Copy Markdown
Collaborator

madhukalita commented Aug 9, 2025

Dear @DivyaJain-DataAnalyst, thanks for your PR! 🙌

We truly appreciate your enthusiasm for upgrading the README file. Your contribution has been merged, but as per our organization guidelines, we have only retained the animated contributors display that will show in the bottom of DevDisplay Readme:

This visual showcase celebrates every contributor’s efforts and adds a dynamic touch to our README - and we absolutely love it! 💙

As for the other changes, like the file structure update and the GSSoC PNG image, we have decided not to include them at this stage. Since DevDisplay is a global organization project with a larger vision, we are keeping certain structural and branding elements consistent across all contributions.

Be sure to share your contribution post on your social like linkedin that you received through DevDisplay mail

Thank you again for your valuable input and for being part of our global vision 🌍✨

@madhukalita madhukalita merged commit 2dc23ed into codeaashu:main Aug 9, 2025
2 checks passed
@DivyaJain-DataAnalyst
Copy link
Copy Markdown
Contributor Author

DivyaJain-DataAnalyst commented Aug 13, 2025

hey @codeaashu @madhukalita

can you add these labels in this PR
(Level 2 & GSSoC '25)

& remove this label [Level 2 - GSSoC '25]

@DivyaJain-DataAnalyst
Copy link
Copy Markdown
Contributor Author

hey @codeaashu @madhukalita

can you add these labels in this PR (Level 2 & GSSoC '25)

& remove this label [Level 2 - GSSoC '25]

@codeaashu

can you add labels
level 2 separate & gssoc'25 separate

@madhukalita madhukalita added Level 2 and removed GSSoC Label for our valued contributors of 🌟 GSSoC '25 Level 2 - GSSoC '25 Dev Enhancer - Refine and enhance the DevDisplay Platform. labels Aug 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Dev Enhancer 🌟 Label 2 for second-time contributors who enhancing and refining features of DevDisplay. 🔧 DevDisplay 🌟 This label recognizes every contributor to the DevDisplay Community for their support...💌 GSSoC'25 Label is used for Issues and pull request related to GSSoC 2025 open source contribution. Level 2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📄 Update README.md for DevDisplay - Improve Project Documentation

3 participants