anuj123upadhyay / MegaBlog

created a blogging site with all functionality using react and appwrite
https://mega-blog-8587.vercel.app/
14 stars 52 forks source link

ADD BUG Report Template #416

Open alo7lika opened 1 week ago

alo7lika commented 1 week ago

Description

Affected Pages:

Type of Documentation Change

Additional Context

The README.md currently lacks detailed information on common bugs users may encounter during installation and setup. Additionally, the Installation Guide has sections that are unclear and could benefit from more specific examples and troubleshooting steps.

Screenshot

Screenshot 2024-10-27 134700

Suggested Improvements

  1. README.md:

    • Add a section on common bugs with clear explanations and potential solutions.
    • Include links to relevant issues for users seeking help.
  2. Installation Guide:

    • Reword the installation steps for clarity, ensuring users understand each step.
    • Add a troubleshooting section with common installation errors and their resolutions.
    • Include a flowchart or visual aid to guide users through the installation process.
  3. Configuration Guide:

    • Clarify any ambiguous terms and provide examples of valid configurations to help users avoid errors.
github-actions[bot] commented 1 week ago

👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!

alo7lika commented 1 week ago

@anuj123upadhyay assign me the task under "GSSOC-EXT"