refactor: update README structure and content for clarity and organiz… #37
Conversation
WalkthroughThe README.md file was extensively restructured to improve organization and clarity for hackathon participants and organizers. Categories were renamed, merged, or introduced, tool descriptions were standardized, and redundant entries were removed. The document now features distinct sections tailored for participants and organizers, with improved navigation and formatting. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
README.md (3)
24-27: Indentation breaks list-within-list renderingThe three sub-entries (Fonts / Icons / Illustrations) are indented with four spaces, which GitHub interprets as code-block context, not a nested list. Prefix with two spaces +
-(or just one tab) so they render as bullets.- - [Fonts](#fonts) - - [Icons](#icons) - - [Illustrations](#illustrations) + - [Fonts](#fonts) + - [Icons](#icons) + - [Illustrations](#illustrations)
102-107: Nit: alphabetical ordering improves scan-abilityWithin “Browser Extensions & Dev Tools” the tools appear random. Alphabetising (ColorZilla, CSSViewer, React DevTools, WhatFont) lets users find an item instantly and reduces churn when adding new entries.
210-216: Clarify the Stability.ai description“- For stable models” is vague and doesn’t convey why a hacker would open the link. E.g.:
- **[Stability.ai](https://stability.ai/)** - For stable models + **[Stability.ai](https://stability.ai/)** - Generative-AI models (Stable Diffusion) with free image API
| - **[1.1.1.1](https://one.one.one.one)** - Free, public DNS resolver from Cloudflare and APNIC | ||
| - **[BrowsecVPN](https://browsec.com/en/=and)** - Free Chrome/Mozilla VPN Extension | ||
| - **[ProtonVPN](https://protonvpn.com)** - Free VPN for Win/Mac/Linux |
There was a problem hiding this comment.
Broken URL for BrowsecVPN
https://browsec.com/en/=and 404s. Drop the junk query string.
- **[BrowsecVPN](https://browsec.com/en/=and)** - Free Chrome/Mozilla VPN Extension
+ **[BrowsecVPN](https://browsec.com/en/)** - Free Chrome/Mozilla VPN extension📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **[1.1.1.1](https://one.one.one.one)** - Free, public DNS resolver from Cloudflare and APNIC | |
| - **[BrowsecVPN](https://browsec.com/en/=and)** - Free Chrome/Mozilla VPN Extension | |
| - **[ProtonVPN](https://protonvpn.com)** - Free VPN for Win/Mac/Linux | |
| - **[1.1.1.1](https://one.one.one.one)** - Free, public DNS resolver from Cloudflare and APNIC | |
| - **[BrowsecVPN](https://browsec.com/en/)** - Free Chrome/Mozilla VPN extension | |
| - **[ProtonVPN](https://protonvpn.com)** - Free VPN for Win/Mac/Linux |
🤖 Prompt for AI Agents
In README.md around lines 259 to 261, the URL for BrowsecVPN contains an invalid
query string '=and' causing a 404 error. Remove the '=and' from the URL so it
correctly points to https://browsec.com/en/ without any extra query parameters.
| ### For Hackathon Participants 👨💻👩💻 | ||
| 1. [AI & Machine Learning](#ai--machine-learning) | ||
| 2. [AI Development Tools](#ai-development-tools) | ||
| 3. [APIs & Data Sources](#apis--data-sources) | ||
| 4. [Authentication & User Management](#authentication--user-management) | ||
| 5. [Backend Development](#backend-development) | ||
| 6. [Blockchain & Web3](#blockchain--web3) | ||
| 7. [Browser Extensions & Dev Tools](#browser-extensions--dev-tools) | ||
| 8. [Collaboration & Communication](#collaboration--communication) | ||
| 9. [Cybersecurity Tools](#cybersecurity-tools) | ||
| 10. [Data Engineering & Analytics](#data-engineering--analytics) | ||
| 11. [Data Visualization](#data-visualization) | ||
| 12. [Database & Storage](#database--storage) | ||
| 13. [Deployment & Hosting](#deployment--hosting) | ||
| 14. [Design & UI/UX](#design--uiux) | ||
| 15. [Design Resources](#design-resources) | ||
| - [Fonts](#fonts) | ||
| - [Icons](#icons) | ||
| - [Illustrations](#illustrations) | ||
| 16. [Frontend Development](#frontend-development) | ||
| - [UI Libraries](#ui-libraries) | ||
| 17. [Game Development](#game-development) | ||
| 18. [Generators & Snippets](#generators--snippets) | ||
| 19. [Inspiration & Ideas](#inspiration--ideas) | ||
| 20. [LLM Models/Tools/Services](#llm-modelstoolsservices) | ||
| 21. [MCP Servers/Tools](#mcp-serverstools) | ||
| 22. [Mobile Development](#mobile-development) | ||
| 23. [Project Starters & Boilerplates](#project-starters--boilerplates) | ||
| 24. [Testing & Quality Assurance](#testing--quality-assurance) | ||
| 25. [VPN & Privacy](#vpn--privacy) | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use automatic numbering to avoid maintenance headaches
The Participant TOC is manually numbered from 1-25. Every future insertion or removal forces a renumber of all subsequent lines – easy to miss, painful in reviews. Markdown will auto-number if every item simply starts with 1. (GitHub, GitLab, etc. all support this).
-1. [AI & Machine Learning](#ai--machine-learning)
-2. [AI Development Tools](#ai-development-tools)
-3. [APIs & Data Sources](#apis--data-sources)
+1. [AI & Machine Learning](#ai--machine-learning)
+1. [AI Development Tools](#ai-development-tools)
+1. [APIs & Data Sources](#apis--data-sources)Same applies to the Organizers section.
Converting once now prevents silent drift later.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### For Hackathon Participants 👨💻👩💻 | |
| 1. [AI & Machine Learning](#ai--machine-learning) | |
| 2. [AI Development Tools](#ai-development-tools) | |
| 3. [APIs & Data Sources](#apis--data-sources) | |
| 4. [Authentication & User Management](#authentication--user-management) | |
| 5. [Backend Development](#backend-development) | |
| 6. [Blockchain & Web3](#blockchain--web3) | |
| 7. [Browser Extensions & Dev Tools](#browser-extensions--dev-tools) | |
| 8. [Collaboration & Communication](#collaboration--communication) | |
| 9. [Cybersecurity Tools](#cybersecurity-tools) | |
| 10. [Data Engineering & Analytics](#data-engineering--analytics) | |
| 11. [Data Visualization](#data-visualization) | |
| 12. [Database & Storage](#database--storage) | |
| 13. [Deployment & Hosting](#deployment--hosting) | |
| 14. [Design & UI/UX](#design--uiux) | |
| 15. [Design Resources](#design-resources) | |
| - [Fonts](#fonts) | |
| - [Icons](#icons) | |
| - [Illustrations](#illustrations) | |
| 16. [Frontend Development](#frontend-development) | |
| - [UI Libraries](#ui-libraries) | |
| 17. [Game Development](#game-development) | |
| 18. [Generators & Snippets](#generators--snippets) | |
| 19. [Inspiration & Ideas](#inspiration--ideas) | |
| 20. [LLM Models/Tools/Services](#llm-modelstoolsservices) | |
| 21. [MCP Servers/Tools](#mcp-serverstools) | |
| 22. [Mobile Development](#mobile-development) | |
| 23. [Project Starters & Boilerplates](#project-starters--boilerplates) | |
| 24. [Testing & Quality Assurance](#testing--quality-assurance) | |
| 25. [VPN & Privacy](#vpn--privacy) | |
| ### For Hackathon Participants 👨💻👩💻 | |
| 1. [AI & Machine Learning](#ai--machine-learning) | |
| 1. [AI Development Tools](#ai-development-tools) | |
| 1. [APIs & Data Sources](#apis--data-sources) | |
| 1. [Authentication & User Management](#authentication--user-management) | |
| 1. [Backend Development](#backend-development) | |
| 1. [Blockchain & Web3](#blockchain--web3) | |
| 1. [Browser Extensions & Dev Tools](#browser-extensions--dev-tools) | |
| 1. [Collaboration & Communication](#collaboration--communication) | |
| 1. [Cybersecurity Tools](#cybersecurity-tools) | |
| 1. [Data Engineering & Analytics](#data-engineering--analytics) | |
| 1. [Data Visualization](#data-visualization) | |
| 1. [Database & Storage](#database--storage) | |
| 1. [Deployment & Hosting](#deployment--hosting) | |
| 1. [Design & UI/UX](#design--uiux) | |
| 1. [Design Resources](#design-resources) | |
| - [Fonts](#fonts) | |
| - [Icons](#icons) | |
| - [Illustrations](#illustrations) | |
| 1. [Frontend Development](#frontend-development) | |
| - [UI Libraries](#ui-libraries) | |
| 1. [Game Development](#game-development) | |
| 1. [Generators & Snippets](#generators--snippets) | |
| 1. [Inspiration & Ideas](#inspiration--ideas) | |
| 1. [LLM Models/Tools/Services](#llm-modelstoolsservices) | |
| 1. [MCP Servers/Tools](#mcp-serverstools) | |
| 1. [Mobile Development](#mobile-development) | |
| 1. [Project Starters & Boilerplates](#project-starters--boilerplates) | |
| 1. [Testing & Quality Assurance](#testing--quality-assurance) | |
| 1. [VPN & Privacy](#vpn--privacy) |
🤖 Prompt for AI Agents
In README.md between lines 8 and 38, the table of contents for Hackathon
Participants is manually numbered from 1 to 25, which makes maintenance
difficult when adding or removing items. To fix this, replace all manual numbers
with `1.` for each list item so that Markdown automatically handles numbering.
Apply the same change to the Organizers section to ensure consistent automatic
numbering and prevent future manual renumbering errors.
|
@HazarBakir How does it look now? |
2 participants
update README structure and content for clarity and organization
issue: #11
issue #10
Summary by CodeRabbit