[GH-ISSUE #2881] DOC: Refactor Hoppscotch Documentation Introduction page #928

New issue

Closed

opened 2026-03-16 17:43:57 +03:00 by kerem · 0 comments

kerem commented

2026-03-16 17:43:57 +03:00

Owner

Originally created by @bhavukkalra on GitHub (Dec 14, 2022).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/2881

I am aware that Documentation is already getting a refactored and is getting improved, maybe this can be added to it.
This proposal aims at making the documentation page more beginner friendly(Keeping in mind a student, Not knowing about Web CORS or How API requests/response work)

Proposal (Sample Page Content) (COVERING THE MOST GENERIC AUDIENCE)-

Divide the main Documentation page into two parts

Brief about

Hoppscotch Web
Hoppscotch Web Extension

Paragraph about CORS (Explaining the need of Web Extension)

[Browser inherent limitation and how Web Extension gets around it]

Beginner Recommended Flow

Making a sample REST Call
Making a REST Call (Getting denied due to CORS
Getting around it (Explaining the steps for installation of extension)

Looking for reviews on this DOC page proposal. If this page should be implemented.
If given a positive response, I can start working on a PR for it.

cc @AndrewBastin @liyasthomas

Originally created by @bhavukkalra on GitHub (Dec 14, 2022). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/2881 I am aware that Documentation is already getting a refactored and is getting improved, maybe this can be added to it. This proposal aims at making the documentation page more beginner friendly(Keeping in mind a student, Not knowing about Web CORS or How API requests/response work) **_Proposal (Sample Page Content) (COVERING THE MOST GENERIC AUDIENCE)-_** Divide the main Documentation page into two parts ![image](https://user-images.githubusercontent.com/41142068/207661815-43889260-4aed-4d09-93cd-634aa9e76429.png) _**Brief about**_ - Hoppscotch Web - Hoppscotch Web Extension **Paragraph about CORS** (Explaining the need of Web Extension) - [Browser inherent limitation and how Web Extension gets around it] Beginner Recommended Flow - Making a sample REST Call - Making a REST Call (Getting denied due to CORS ![image](https://user-images.githubusercontent.com/41142068/207663181-6bd503b1-78e4-4629-9195-5228fee1e468.png) - Getting around it (Explaining the steps for installation of extension) Looking for reviews on this DOC page proposal. If this page should be implemented. If given a positive response, I can start working on a PR for it. cc @AndrewBastin @liyasthomas