Skip to content
New issue

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

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

Already on GitHub? # to your account

Documentation Enhancements: #3

Open
Anu27n opened this issue Dec 25, 2024 · 1 comment
Open

Documentation Enhancements: #3

Anu27n opened this issue Dec 25, 2024 · 1 comment
Assignees
Labels
🪲 Bug Something isn't working

Comments

@Anu27n
Copy link

Anu27n commented Dec 25, 2024

1)Provide detailed usage examples with screenshots for every feature in the scripts.
2)Include troubleshooting steps for common installation issues, especially for Import from URL and GitHub download options.
3)Add a "Frequently Asked Questions" (FAQ) section addressing common user queries.

The current README is quite lengthy and difficult to read. The screenshots included seem unclear—especially if they are from Snapchat or elsewhere—and are not easy to interpret. Please make the documentation more concise and ensure the screenshots are clearer and relevant to the context.

@Anu27n Anu27n added the 🪲 Bug Something isn't working label Dec 25, 2024
@Beingzain
Copy link
Collaborator

Hey @Anu27n, we are delighted that you made a suggestion, and we are going to make further improvements to the Readme when development is presumed to be complete. Have a nice day, regards from @Beingzain and @suryadip2008.

@Beingzain Beingzain reopened this Dec 27, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
🪲 Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants