docs: make README more beginner-friendly - #53
Open
pwb25 wants to merge 1 commit into
Open
Conversation
Add context on what DevHub is, expand setup steps with plain-language explanations, and describe the purpose of each top-level folder so newcomers can navigate the project without prior context. Also adds the contrib.rocks contributors image as requested in the issue. Closes open-devhub#51
Author
|
ㄴㅇㅁㄹ |
Author
|
ㄴㄹㄴㄹ |
calebephrem
requested changes
Jul 26, 2026
calebephrem
left a comment
calebephrem
left a comment
Member
There was a problem hiding this comment.
Thank you for opening this pr!
You've done nice work, but I think this structure is more like it:
| # DevHub | ||
|
|
||
| The official website for the DevHub developer community. Built with Next.js, TypeScript, and Tailwind CSS. | ||
| DevHub is a developer community focused on helping people learn, build, and connect with other developers. This repository holds the source for [devhub.vercel.app](https://devhub.vercel.app) — the community's website, including the landing page, guides, and resource library. |
Member
There was a problem hiding this comment.
Suggested change
| DevHub is a developer community focused on helping people learn, build, and connect with other developers. This repository holds the source for [devhub.vercel.app](https://devhub.vercel.app) — the community's website, including the landing page, guides, and resource library. | |
| The official website for DevHub, a developer community focused on helping people learn, build, and connect with other developers. This repo holds the source code for the site: the landing page, community rules, guides, the resource library, articles, and the partners page. |
Comment on lines
+5
to
+7
| New to the project? This README walks you through what's here, how to run it locally, and how the code is organized, so you can start contributing without needing to already know the codebase. | ||
|
|
||
| Built with Next.js, TypeScript, and Tailwind CSS. |
Member
There was a problem hiding this comment.
Suggested change
| New to the project? This README walks you through what's here, how to run it locally, and how the code is organized, so you can start contributing without needing to already know the codebase. | |
| Built with Next.js, TypeScript, and Tailwind CSS. | |
| If you're new here, welcome. This README is written to get you from cloning to making your first change with no prior context needed. |
Comment on lines
11
to
26
| - Landing page | ||
| - Community guides | ||
| - Resource library, curated tools and learning materials | ||
| - Partners page | ||
| - DevHub Pages: | ||
| - Getting Started | ||
| - Join Guide | ||
| - Server Info | ||
| - How to Ask | ||
| - How to Help | ||
| - Code of Conduct | ||
| - Contributing | ||
| - Moderation Guide | ||
| - Staff Roles | ||
| - FAQ | ||
| - and many many more |
Member
There was a problem hiding this comment.
Suggested change
| - Landing page: intro to DevHub and what the community offers | |
| - Pages: guides like Getting Started, How to Ask, How to Help, Code of Conduct, Contributing, Moderation Guide, Staff Roles, FAQ, and more | |
| - Resource library: curated tools and learning materials | |
| - Articles: write-ups from the community | |
| - Rules: the server/community rules, in one place | |
| - Partners: communities and projects DevHub partners with |
Comment on lines
30
to
36
| - **Framework** - Next.js | ||
| - **Language** - TypeScript | ||
| - **Styling** - Tailwind CSS | ||
| - **Animation Libriary** - GSAP and Framer Motion | ||
| - **Component Libriary** - React Bits | ||
| - **Icons** - Lucide | ||
| - **Deployment** - Vercel |
Member
There was a problem hiding this comment.
Suggested change
| - **Deployment** - Vercel | |
| | Purpose | Tool | | |
| | ---------- | ------------------- | | |
| | Framework | Next.js | | |
| | Language | TypeScript | | |
| | Styling | Tailwind CSS | | |
| | Animation | GSAP, Framer Motion | | |
| | Components | React Bits | | |
| | Icons | Lucide | | |
| | Deployment | Vercel | | |
| - **Icons** - Lucide | ||
| - **Deployment** - Vercel | ||
|
|
||
| If you're new to any of these, you don't need to be an expert to contribute — most changes only touch a small part of the stack at a time. |
Member
There was a problem hiding this comment.
Suggested change
| If you're new to any of these, you don't need to be an expert to contribute — most changes only touch a small part of the stack at a time. | |
| You don't need to know all of these before contributing. Most changes only touch one or two of them at a time. |
| 2. Create a branch (`git checkout -b feature/your-cool-feature`) | ||
| 3. Make your changes | ||
| 4. Run `npm run lint` | ||
| 5. Open a PR with a clear description |
Member
There was a problem hiding this comment.
Suggested change
| 5. Open a PR with a clear description | |
| 5. Test your changes locally | |
| 6. Open a PR with a clear description |
| 5. Open a PR with a clear description | ||
|
|
||
| First time contributing to open source? Look for issues tagged [`good first issue`](https://github.com/open-devhub/website/issues?q=is%3Aopen+label%3A%22good+first+issue%22). | ||
| First time contributing to open source? Look for issues tagged [`good first issue`](https://github.com/open-devhub/website/issues?q=is%3Aopen+label%3A%22good+first+issue%22) — they're scoped to be approachable even if you've never opened a PR before. |
Member
There was a problem hiding this comment.
Suggested change
| First time contributing to open source? Look for issues tagged [`good first issue`](https://github.com/open-devhub/website/issues?q=is%3Aopen+label%3A%22good+first+issue%22) — they're scoped to be approachable even if you've never opened a PR before. | |
| New to open source? Look for issues tagged [`good first issue`](https://github.com/open-devhub/website/issues?q=is%3Aopen+label%3A%22good+first+issue%22). These are picked specifically to be approachable for first-time contributors. |
Comment on lines
209
to
213
| npm run dev # Start development server | ||
| npm run build # Production build | ||
| npm run start # Start production server | ||
| npm run lint # Run ESLint | ||
| npm run format # Run Prettier |
Member
There was a problem hiding this comment.
Suggested change
| npm run dev # Start development server | |
| npm run build # Production build | |
| npm run start # Start production server | |
| npm run lint # Run ESLint | |
| npm run typecheck # Check for type errors | |
| npm run format # Run Prettier |
|
|
||
| ## Community | ||
|
|
||
| - **Discord** - [devhub.vercel.app/join](https://devhub.vercel.app/join) |
Member
There was a problem hiding this comment.
Suggested change
| - **Website** - [devhub.vercel.app](https://devhub.vercel.app) | |
| - **Discord** - [devhub.vercel.app/join](https://devhub.vercel.app/join) |
| Licensed under the GNU GPL v3.0 License. See the [LICENSE](./LICENSE) file for details. | ||
|
|
||
| ## Contributors | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| Thanks to everyone who has contributed to this repository. | |
Member
Our very bad, would you mind correcting that too? |
Member
Member
|
@pwb25 you there? |
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
2 participants
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.
What
Rewrites the README to be more approachable for newcomers:
app/,components/,content/,lib/,hooks/) is for, so new contributors can navigate the codebase without prior contextcontrib.rockscontributors image at the end, as requested in the issueWhy
Closes #51. The previous README was accurate but terse, assuming familiarity with the stack and project layout. This makes it easier for first-time contributors to get oriented.
Notes
README.md), no code or behavior changes.develop, but this repo currently only has amainbranch, so I opened againstmain.npm run lint/npm run buildper the PR checklist — this change only touches Markdown text, but flagging it in case a maintainer wants to double check.