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

DOC: Restructure Documentation and Cleanup README with new FAQ section added #240

Open
HelloSniperMonkey opened this issue Jan 26, 2025 · 4 comments · May be fixed by #241
Open

DOC: Restructure Documentation and Cleanup README with new FAQ section added #240

HelloSniperMonkey opened this issue Jan 26, 2025 · 4 comments · May be fixed by #241

Comments

@HelloSniperMonkey
Copy link
Contributor

Issue with current documentation:

Issue with Current Documentation:

The current documentation lacks comprehensive guidelines for common issues encountered during project setup and troubleshooting, particularly for platform-specific environments like macOS, Android, Windows, and the web browser. As a contributor, I encountered the following while setting up the project:

  • Successfully set up the project on macOS and browser versions, but faced challenges setting up for other target platforms.

  • Lack of a consolidated FAQ section that addresses common setup problems and their solutions.

Suggested Improvements:

Create an FAQ document to address commonly faced issues, such as:

  • Environment setup instructions for various platforms (macOS, Windows, Android, iOS, Web) and how other people setup their project and what hurdles they faced and how they solved them.

  • Debugging production-specific issues vs. browser-specific ones.

  • Steps to resolve platform-specific errors such as keychanin error in macos, jdk verion not compatible with gradle version, etc .

Benefits:

  • Saves time for new contributors by providing a quick resolution to frequently encountered issues.
  • This will enhances project maintainability by standardizing issue reporting and .
  • Encourages broader contributions across all platforms.
@HelloSniperMonkey HelloSniperMonkey linked a pull request Jan 26, 2025 that will close this issue
4 tasks
@HelloSniperMonkey
Copy link
Contributor Author

@mdmohsin7 please review this PR at your convenient time

@mdmohsin7
Copy link
Collaborator

I've reviewed the PR. Please also update this issue to reflect the overall documentation changes requested in the PR.

@HelloSniperMonkey
Copy link
Contributor Author

Ok I will do that as soon as I can

@HelloSniperMonkey HelloSniperMonkey changed the title DOC: FAQ and Issue Reporting Guidelines DOC: Restructure Documentation and Cleanup README with new FAQ section added Feb 7, 2025
@HelloSniperMonkey
Copy link
Contributor Author

@mdmohsin7 i have done the things you have suggested please merge this PR at your convenient time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants