docs icon indicating copy to clipboard operation
docs copied to clipboard

Add Multimedia Elements throughout Documentation for Better User Understanding

Open SanskritiHarmukh opened this issue 1 year ago • 2 comments

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 avatar Jun 19 '24 08:06 SanskritiHarmukh

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

ganeshpatil386386 avatar Sep 12 '24 09:09 ganeshpatil386386

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

SanskritiHarmukh avatar Sep 12 '24 10:09 SanskritiHarmukh