Skip to content

Navigation Menu

Sign in
Sign up

Enhance README Documentation for React Developer Community Kenya Website - #147

Open
festus-sulumeti wants to merge 1 commit into
reactdeveloperske:prod from
festus-sulumeti:chore/update-readme
Open

Enhance README Documentation for React Developer Community Kenya Website #147
festus-sulumeti wants to merge 1 commit into
reactdeveloperske:prod from
festus-sulumeti:chore/update-readme

Conversation

@festus-sulumeti

@festus-sulumeti festus-sulumeti commented Mar 26, 2025

Copy link
Copy Markdown
Member

This PR updates the README.md file to provide a more detailed and structured documentation for the project. The goal is to improve onboarding for new contributors, provide clear project details, and make the repository more informative.

Changes Introduced

  • Added a Project Overview with goals and technologies used.
  • Included a Live Demo section with a link and potential screenshots/GIFs.
  • Organized a Table of Contents for easy navigation.
  • Expanded the Features list for better clarity.
  • Detailed Getting Started steps, including installation and running locally.
  • Enhanced Contributing Guidelines with step-by-step instructions.
  • Provided a Figma Design section with a reference link.
  • Added an FAQs section to address common questions.
  • Updated License information and provided a direct link.
  • Included Contact Information for community engagement.

Checklist

  • Ensure all sections are well-structured and easy to read.
  • Verify all links (live demo, Figma, contributing guide, etc.) are working correctly.
  • Confirm markdown formatting follows best practices.
  • Gather feedback from the community before merging.

###Related
Closes: #146

vercel Bot commented Mar 26, 2025

Copy link
Copy Markdown

@festus-sulumeti is attempting to deploy a commit to the React Developers Kenya Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Member

@festus-sulumeti, thanks for this contribution. as per the contribution guidelines, try make the pull request against the develop branch.

Comment thread README.md
Contributions are always welcome!

See [`contributing.md`](https://github.com/reactdeveloperske/reactdevske-website/blob/main/CONTRIBUTING.md) for ways to get started.
### How to Contribute

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@festus-sulumeti

For the contribution guidelines section, emphasize on the detailed instructions that are available on the contribution guidelines. Some steps are missing from this summary which are very important and are addressed on the contribution guidelines,

Comment thread README.md
- **Node.js**: Backend runtime.
- **Tailwind CSS**: Styling.
- **GitHub Actions**: CI/CD.
- **Netlify/Vercel**: Deployment.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Deployments are done on Vercel

Comment thread README.md
## Figma design file
## Technologies Used

- **React.js**: Frontend framework.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Add React,js as the frontend javascript library

Comment thread README.md
## Technologies Used

- **React.js**: Frontend framework.
- **Node.js**: Backend runtime.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Add Next.js as the Frontend React Framework.

Comment thread README.md

### 2. How do I report a bug?

You can report bugs by creating an issue in the [GitHub Issues](https://github.com/reactdeveloperske/reactdevske-website/issues) section.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also add that one has to go through the contribution guidelines (add a markdown link) for guidance

Comment thread README.md

### 3. Can I suggest new features?

Absolutely! Feel free to open a feature request in the [GitHub Issues](https://github.com/reactdeveloperske/reactdevske-website/issues) section.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also add that one has to go through the contribution guidelines (add a markdown link) for guidance

Comment thread README.md
React Developers Kenya Community
Email: [reactdevske@gmail.com](mailto:reactdevske@gmail.com)
Website: [reactdevske.org](https://www.reactdevske.org/)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@orama254 orama254 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hello @festus-sulumeti

Thank's for your contribution, check out the comments added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@orama254 orama254 orama254 requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create a Detailed README for React Developer Community Kenya Website

AltStyle によって変換されたページ (->オリジナル) /