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

📃Create Comprehensive Documentation for Bot Usage #9

Open
1 of 4 tasks
Salz0 opened this issue Oct 20, 2023 · 2 comments
Open
1 of 4 tasks

📃Create Comprehensive Documentation for Bot Usage #9

Salz0 opened this issue Oct 20, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation hacktoberfest middle

Comments

@Salz0
Copy link
Owner

Salz0 commented Oct 20, 2023

Summary: 📝

Create documentation that provides instruction on how to use and install the Flea Market Telegram Bot, aimed at both users and potential contributors.

Proposed Solution: 🛠

  • Write a comprehensive guide on how to use all existing features of the bot.
  • Include step-by-step screenshots or short video clips for complex processes.
  • Add an FAQ section to address common questions. (or leave space for future considerations)
  • Include a section that outlines how contributors can set up the development environment and add new features. + find the variables
  • Update the README.md to include a link to the new documentation.

Acceptance Criteria: ✅

  • Documentation is complete
  • Step-by-step guides are clear and easy to follow.
  • An FAQ section is added. (even if empty)
  • README.md is updated with the link to the new documentation.

Additional Information: ℹ️

This documentation will be the primary source of information for users and new contributors, so it needs to be as clear and comprehensive as possible. It would be beneficial to get feedback from both users and other developers to ensure all bases are covered.

Thank you for considering this issue. Proper documentation will significantly improve the user experience and encourage more contributions to the project. 📚🤖👥

@Salz0 Salz0 added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest high-priority labels Oct 20, 2023
@Salz0 Salz0 changed the title Create Comprehensive Documentation for Bot Usage 📃Create Comprehensive Documentation for Bot Usage Oct 20, 2023
@ShrutiKolla
Copy link

@Salz0 can you please assign this to me?

@Salz0
Copy link
Owner Author

Salz0 commented Oct 21, 2023

@Salz0 can you please assign this to me?

Hey! You can work on it right-away, create a pull request and I will merge if everything is fine 🙏

@Salz0 Salz0 added middle and removed good first issue Good for newcomers high-priority labels Oct 27, 2023
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 hacktoberfest middle
Projects
None yet
Development

No branches or pull requests

2 participants