Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Update docs to get started #119

Closed
Codehagen opened this issue Feb 6, 2024 · 2 comments · Fixed by #188
Closed

Feature: Update docs to get started #119

Codehagen opened this issue Feb 6, 2024 · 2 comments · Fixed by #188
Assignees
Labels
📕 documentation Improvements or additions to documentation 🚀 Good first issue Good for newcomers

Comments

@Codehagen
Copy link
Member

Codehagen commented Feb 6, 2024

Type of feature

📝 Documentation

Current Behavior

Currently, our project documentation lacks detailed instructions for setting up the project locally. This gap can hinder new contributors from getting started and contributing to the project effectively.

Problem Statement

Our /docs section at https://projectx-eight-gilt.vercel.app/docs needs a comprehensive update to make the initial setup process for contributors smoother and more straightforward. There's a clear need to enrich our documentation with step-by-step instructions on how to set up the project locally, ensuring that new contributors can easily navigate their way through their initial setup and contribution.

Proposed Solution

I propose we expand the /docs section to include:

  • Detailed instructions for setting up the project locally, covering prerequisites, installation steps, and common troubleshooting tips.
  • A clear explanation of the project structure and key components to help contributors understand where and how they can contribute.
  • Links to additional resources or tools that contributors might find useful during their setup process.

This update will not only facilitate a better onboarding experience for new contributors but also enhance the overall contribution process by providing clear guidelines and reducing setup friction.

@Codehagen Codehagen added 📕 documentation Improvements or additions to documentation 🚀 Good first issue Good for newcomers labels Feb 6, 2024
@shouryan01
Copy link
Collaborator

shouryan01 commented Feb 28, 2024

@meglerhagen can I take this? The other issues already have a taker

@Codehagen
Copy link
Member Author

Would love to have you on this @shouryan01. Do you have any questions feel free to contact me here or on Discord ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📕 documentation Improvements or additions to documentation 🚀 Good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants