[GH-ISSUE #206] Add Multimedia Elements throughout Documentation for Better User Understanding #60

New issue

Open

opened 2026-03-16 12:22:42 +03:00 by kerem · 2 comments

kerem commented

2026-03-16 12:22:42 +03:00

Owner

Originally created by @SanskritiHarmukh on GitHub (Jun 19, 2024).
Original GitHub issue: https://github.com/hoppscotch/docs/issues/206

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.

Originally created by @SanskritiHarmukh on GitHub (Jun 19, 2024). Original GitHub issue: https://github.com/hoppscotch/docs/issues/206 ## 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](https://github.com/hoppscotch/docs/blob/main/README.md). - For adding and styling these multimedia elements, check out the Mintlify components. Learn how to use them through their [documentation](https://mintlify.com/docs/quickstart).

kerem added the

testmu

label

2026-03-16 12:22:42 +03:00

kerem commented

2026-03-16 12:22:53 +03:00

Author

Owner

@ganeshpatil386386 commented on GitHub (Sep 12, 2024):

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

@ganeshpatil386386 commented on GitHub (Sep 12, 2024): Hey @SanskritiHarmukh can you guide me what actually need to be done here.

kerem commented

2026-03-16 12:22:58 +03:00

Author

Owner

@SanskritiHarmukh commented on GitHub (Sep 12, 2024):

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

@SanskritiHarmukh commented on GitHub (Sep 12, 2024): @ganeshpatil386386 we are keeping this issue on hold right now.