[GH-ISSUE #1] Missing documentation - contributors wanted #10

New issue

Closed

opened 2026-03-16 12:15:11 +03:00 by kerem · 2 comments

kerem commented

2026-03-16 12:15:11 +03:00

Owner

Originally created by @lmm-git on GitHub (Mar 31, 2021).
Original GitHub issue: https://github.com/hoppscotch/docs/issues/1

When we started using Hoppscotch today, we were not able to find documentation on how to use the environment variables correctly. In the end, we found https://github.com/hoppscotch/hoppscotch/issues/1029#issuecomment-731157816 which solved the issue for us, but we lost certainly about 1 hour until we found that comment.

Describe the solution you'd like
It would be nice to have some kind of documentation on how to use the environment variable next to the place where you can configure them (Environments, probably where you can enter the values?).

Additional context
It might not be intuitive that it is not possible to use environment variables in Parameters but in the URL.

Originally created by @lmm-git on GitHub (Mar 31, 2021). Original GitHub issue: https://github.com/hoppscotch/docs/issues/1 When we started using Hoppscotch today, we were not able to find documentation on how to use the environment variables correctly. In the end, we found https://github.com/hoppscotch/hoppscotch/issues/1029#issuecomment-731157816 which solved the issue for us, but we lost certainly about 1 hour until we found that comment. **Describe the solution you'd like** It would be nice to have some kind of documentation on how to use the environment variable next to the place where you can configure them (Environments, probably where you can enter the values?). **Additional context** It might not be intuitive that it is not possible to use environment variables in Parameters but in the URL.

kerem closed this issue

2026-03-16 12:15:16 +03:00

kerem commented

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

Author

Owner

@liyasthomas commented on GitHub (Mar 31, 2021):

An application wide support for environment variables is coming soon. What we've right now is much more like a proof of concept. Anyways thanks for raising the concern. We'll keep an eye out to work on this feature.

And regarding the documentation, well as of now Hoppscotch don't have a definite documention page apart from our Wiki. We're looking forward on hosting a documentation site for Hoppscotch in docs.hoppscotch.io pretty soon if we could find contributors. The core team is quite busy with developing few essential stuffs which why things such as documentation is in backlog. You can read our Pre-Request Scripts Wiki page to read more on Environments and usage. Also I suppose we should make it obvious for the user to discover this documentation directly from the related UI components. Thanks for all the inputs.

@liyasthomas commented on GitHub (Mar 31, 2021): An application wide support for environment variables is coming soon. What we've right now is much more like a proof of concept. Anyways thanks for raising the concern. We'll keep an eye out to work on this feature. And regarding the documentation, well as of now Hoppscotch don't have a definite documention page apart from our [Wiki](https://github.com/hoppscotch/hoppscotch/wiki). We're looking forward on hosting a documentation site for Hoppscotch in `docs.hoppscotch.io` pretty soon if we could find contributors. The core team is quite busy with developing few essential stuffs which why things such as documentation is in backlog. You can read our [Pre-Request Scripts Wiki page](https://github.com/hoppscotch/hoppscotch/wiki/Pre-Request-Scripts) to read more on Environments and usage. Also I suppose we should make it obvious for the user to discover this documentation directly from the related UI components. Thanks for all the inputs.

kerem commented

2026-03-16 12:15:27 +03:00

Author

Owner

@liyasthomas commented on GitHub (Apr 1, 2021):

A minor update: We now have a documentation site up and running on Hoppscotch Documentation.

Website: https://docs.hoppscotch.io
Repository: https://github.com/hoppscotch/docs

We'll be updating documentation and move Wiki page completely to new website in couple of days. Let us know your feedbacks, suggestions and topics that need to be covered in documentation. Moving forward, we'll be covering topics from README to documentation.

Contributions are welcome

Use the "Edit this page" button on documentation to directly fork and make changes to documentation by raising a PR.
Alternately, use instructions from README to set-up a local development environment of documentation amd raise a PR.

@liyasthomas commented on GitHub (Apr 1, 2021): A minor update: We now have a documentation site up and running on [Hoppscotch Documentation]( https://docs.hoppscotch.io). Website: https://docs.hoppscotch.io Repository: https://github.com/hoppscotch/docs We'll be updating documentation and move Wiki page completely to new website in couple of days. Let us know your feedbacks, suggestions and topics that need to be covered in documentation. Moving forward, we'll be covering topics from README to documentation. # Contributions are welcome - Use the "Edit this page" button on documentation to directly fork and make changes to documentation by raising a PR. - Alternately, use instructions from README to set-up a local development environment of documentation amd raise a PR.

kerem referenced this issue

2026-03-16 12:27:10 +03:00

[PR #10] [MERGED] Added Features and Updated Guide #117