DEV Community

Cover image for Introducing the new Hoppscotch documentation
Kiran Johns for Hoppscotch

Posted on

Introducing the new Hoppscotch documentation

We are excited to announce the launch of our revamped documentation website. The new Hoppscotch docs feature an updated design, improved navigation, and enhanced search capabilities to make it easier than ever to find the information you need.

Here are some of the improvements in out latest documentation:

Simplified Navigation & Content organization

We’ve updated the navigation to make the documentation as simple and intuitive as possible to use. The top navbar now contains links to three pages: Documentation, Guides, and Support.

The Documentation page serves as a centralized hub for all information about Hoppscotch. Here, you'll find detailed explanations of Hoppscotch's core features and capabilities, as well as step-by-step instructions for getting started.

The Guides page features specific tutorials and walkthroughs that teach you how to leverage Hoppscotch for your key workflows and use cases. We provide guidance for both common and advanced scenarios to help ensure that you get the most out of all that Hoppscotch has to offer.

The Support page aggregates Hoppscotch's support resources into one place. This includes community discussion forums and direct contact information for reaching out to our expert support team. Whether you have a quick question or require more personalized assistance, we are here to help you along your journey using Hoppscotch.

Image of Hoppscotch Documentation

The left pane displays different sections under each page, providing an expanded view of the documentation's organizational structure. We’ve also reorganized the sections in the left pane so that related contents are logically grouped into a streamlined, user-friendly knowledge base.

The right pane shows the Table of Contents for each section in more depth and detail, allowing you to easily navigate to the specific content you need. We have designed the page layout and content outlines with clarity and comprehensiveness in mind, making it simple to explore all the information Hoppscotch has to offer.

Easy-to-Follow Tutorials

The getting started section features step-by-step tutorials on how you can get started with Hoppscotch. You now easily get started with testing your REST APIs, GraphQL endpoints and real-time APIs, we make it super easy for you to get up and running in no time.

We provide a guided walkthrough for setting up Hoppscotch so that you can begin testing your APIs immediately. Hoppscotch is designed to get out of your way and let you focus on building great APIs. Whether you're just getting started with API testing or looking to improve your existing workflow, the Hoppscotch documentation has you covered.

Instantly Find Anything: Super Quick Search

Image of the search feature in Hoppscotch Documentation

We know how finding specific information can be tough, so we added a search capability using Algolia so that you can find anything about Hoppscotch in the blink of an eye. Finding information is now instantaneous and intuitive. Just enter your Hoppscotch-related query and our search will display results instantly.

Beautiful & User-Friendly Design:

Image of the updated UI in Hoppscotch documentation

Lastly and obviously as you guessed it we updated the design. We’re now using Docus as the base of our documentation website and it looks elegant. The redesigned documentation website has a modern yet minimal feel that highlights our content and resources in a simple, accessible way for all users. The new design is flexible, mobile-friendly, and optimized for an excellent user experience across all devices.

We hope these improvements make the Hoppscotch documentation more useful than ever. You can check out the new and updated documentation at https://docs.hoppscotch.io and get started with Hoppscotch at https://hoppscotch.io. Do let us know if you have any feedback or run into any issues using the new docs.

The Hoppscotch Team

Top comments (0)