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.

Sign up for GitHub

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

Jump to bottom

Add a Troubleshooting and Onboarding Section to Documentation #60

Open
adityabhattad2021 opened this issue Dec 9, 2024 · 3 comments · May be fixed by #72
Open

Add a Troubleshooting and Onboarding Section to Documentation #60

adityabhattad2021 opened this issue Dec 9, 2024 · 3 comments · May be fixed by #72
Labels
good first issue Good for newcomers

Comments

@adityabhattad2021
Copy link
Contributor

To improve the onboarding experience for new developers, we can create a dedicated "Troubleshooting" section in the repository documentation. This section should:

  1. Cover solutions to common issues encountered while setting up the repo.
  2. Clarify common assumptions about the codebase and its dependencies.
  3. Provide a small video tutorial to visually guide new contributors through the setup process.
@adityabhattad2021 adityabhattad2021 added the good first issue Good for newcomers label Dec 9, 2024
@naxatra2 naxatra2 mentioned this issue Dec 9, 2024
Closed
3 tasks
@meetjn
Copy link
Contributor

meetjn commented Jan 29, 2025

Hi @adityabhattad2021 , Can I work upon this?

@adityabhattad2021
Copy link
Contributor Author

Yes, sure!

@meetjn
Copy link
Contributor

meetjn commented Feb 6, 2025

Quick update:
Troubleshooting and common codebase assumptions are done, now shooting a video for project setting up! @adityabhattad2021

This was referenced Feb 11, 2025
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added troubleshooting part meetjn/FairFund
update README.md naxatra2/FairFund-naxatra
2 participants
@adityabhattad2021 @meetjn