starred/hoppscotch

Fork 0

mirror of https://github.com/hoppscotch/hoppscotch.git synced 2026-04-25 16:55:59 +03:00

[GH-ISSUE #232] Lacking documentation and wiki #82

New issue

Closed

opened 2026-03-16 13:16:08 +03:00 by kerem · 6 comments

kerem commented

2026-03-16 13:16:08 +03:00

Owner

Originally created by @liyasthomas on GitHub (Oct 30, 2019).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/232

Originally assigned to: @liyasthomas, @NBTX on GitHub.

Is your feature request related to a problem? Please describe.
Accept the fact that postwoman.io have zero docs and wiki 😞

Describe the solution you'd like
Make the wiki, write the docs: https://github.com/liyasthomas/postwoman/wiki

Describe alternatives you've considered
Host docs on postwoman.io itself.

Additional context
Wiki is essential while adding new features, making any changes breaking changes, updating format/features etc.

Originally created by @liyasthomas on GitHub (Oct 30, 2019). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/232 Originally assigned to: @liyasthomas, @NBTX on GitHub. **Is your feature request related to a problem? Please describe.** Accept the fact that postwoman.io have zero docs and wiki 😞 **Describe the solution you'd like** Make the wiki, write the docs: https://github.com/liyasthomas/postwoman/wiki **Describe alternatives you've considered** Host docs on postwoman.io itself. **Additional context** Wiki is essential while adding new features, making any changes breaking changes, updating format/features etc.

kerem

2026-03-16 13:16:08 +03:00

closed this issue
added the
help wanted

good first issue

documentation

wip
labels

kerem commented

2026-03-16 13:16:24 +03:00

Author

Owner

@nickpalenchar commented on GitHub (Oct 30, 2019):

I was just thinking about this. Don't want to add complexity too quickly, but gitbooks seem to produce great documentation. I need to do some research but I believe they can be hosted from a docs/ directory in github, and would be a part of VCS along the rest of the codebase (not to mention documentation edits would be a green square for a contributors github profile 😎 )

Of course just starting to write anything in the github wiki is easy for every/anyone to do, and could easily be moved over to gitbook later as it's all markdown

@nickpalenchar commented on GitHub (Oct 30, 2019): I was just thinking about this. Don't want to add complexity too quickly, but [gitbooks](https://www.npmjs.com/package/gitbook) seem to produce great documentation. I need to do some research but I believe they can be hosted from a `docs/` directory in github, and would be a part of VCS along the rest of the codebase (not to mention documentation edits would be a green square for a contributors github profile 😎 ) Of course just starting to write anything in the github wiki is easy for every/anyone to do, and could easily be moved over to gitbook later as it's all markdown

kerem commented

2026-03-16 13:16:29 +03:00

Author

Owner

@NBTX commented on GitHub (Oct 30, 2019):

You can use GitHub pages and that will work from a specific branch or a docs/ directory. But to add, another perk of GitHub pages would be that we could theme it as we please.

I definitely think we should use the GitHub Wiki as a draft for the docs.

@NBTX commented on GitHub (Oct 30, 2019): You can use GitHub pages and that will work from a specific branch or a docs/ directory. But to add, another perk of GitHub pages would be that we could theme it as we please. I definitely think we should use the GitHub Wiki as a draft for the docs.

kerem commented

2026-03-16 13:16:34 +03:00

Author

Owner

@liyasthomas commented on GitHub (Oct 31, 2019):

Will wirte Github Wiki first.

GitBook for build ✔️
GitHub pages for hosting ✔️

@liyasthomas commented on GitHub (Oct 31, 2019): Will wirte Github Wiki first. GitBook for build ✔️ GitHub pages for hosting ✔️

kerem commented

2026-03-16 13:16:39 +03:00

Author

Owner

@yubathom commented on GitHub (Oct 31, 2019):

This would be nice!

Maybe a vue based doc builder should be considered. I use vuepress for documentation and I think it is awesome. A helpful feature is the capability of it to load vue components in docs markdown. But agree that wiki is certainly a good start.

@yubathom commented on GitHub (Oct 31, 2019): This would be nice! Maybe a vue based doc builder should be considered. I use vuepress for documentation and I think it is awesome. A helpful feature is the capability of it to [load vue components in docs markdown](https://vuepress.vuejs.org/guide/using-vue.html#using-components). But agree that wiki is certainly a good start.

kerem commented

2026-03-16 13:16:44 +03:00

Author

Owner

@liyasthomas commented on GitHub (Oct 31, 2019):

How about we add a help [?] button on sections with link to its corresponding wiki pages as I finish docs.

@liyasthomas commented on GitHub (Oct 31, 2019): How about we add a help **[?]** button on sections with link to its corresponding wiki pages as I finish docs.

kerem commented

2026-03-16 13:16:50 +03:00

Author

Owner

@sabatesduran commented on GitHub (Nov 6, 2019):

I know you are using Firebase, but have you tried Netlify? Now with every commit you can build multiple sites 😄 (For free)

@sabatesduran commented on GitHub (Nov 6, 2019): I know you are using Firebase, but have you tried Netlify? Now with every commit you can build multiple sites :smile: (For free)

kerem referenced this issue

2026-03-17 00:06:36 +03:00

[PR #82] [MERGED] Add editorconfig #2405