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

Add Multimedia Elements throughout Documentation for Better User Understanding #206

Open
SanskritiHarmukh opened this issue Jun 19, 2024 · 2 comments
Labels
testmu The issue or PR is related to the Hoppscotch Code Quest Challenge under TestMu Conference

Comments

@SanskritiHarmukh
Copy link
Collaborator

SanskritiHarmukh commented Jun 19, 2024

Overview:

Right now, our documentation could really use some visual flair. We've noticed that we're missing out on images, gifs, and videos that could really help users understand the ins and outs of APIs and how to use Hoppscotch effectively.

What You Need to Do:

Let's spruce up the Documentation pages by adding some multimedia to it. Think videos that demonstrate key features, helpful images and flow diagrams that break down complex concepts, or even fun gifs that lighten the learning process.

Resources:

  • Open the documentation in Dev mode by following the instructions in the README file.
  • For adding and styling these multimedia elements, check out the Mintlify components. Learn how to use them through their documentation.
@SanskritiHarmukh SanskritiHarmukh added the fosshack This issue or PR is relegated for FOSS Hack Partner Projects Program label Jun 19, 2024
@SanskritiHarmukh SanskritiHarmukh added testmu The issue or PR is related to the Hoppscotch Code Quest Challenge under TestMu Conference and removed fosshack This issue or PR is relegated for FOSS Hack Partner Projects Program labels Aug 16, 2024
@ganeshpatil386386
Copy link
Contributor

Hey @SanskritiHarmukh
can you guide me what actually need to be done here.

@SanskritiHarmukh
Copy link
Collaborator Author

@ganeshpatil386386 we are keeping this issue on hold right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testmu The issue or PR is related to the Hoppscotch Code Quest Challenge under TestMu Conference
Projects
None yet
Development

No branches or pull requests

2 participants