Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lacking documentation and wiki #232

Open
liyasthomas opened this issue Oct 30, 2019 · 6 comments

Comments

@liyasthomas
Copy link
Owner

@liyasthomas liyasthomas commented Oct 30, 2019

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.

@nickpalenchar

This comment has been minimized.

Copy link
Collaborator

@nickpalenchar nickpalenchar commented 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

@NBTX

This comment has been minimized.

Copy link
Collaborator

@NBTX NBTX commented 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.

@liyasthomas

This comment has been minimized.

Copy link
Owner Author

@liyasthomas liyasthomas commented Oct 31, 2019

Will wirte Github Wiki first.

GitBook for build 鉁旓笍
GitHub pages for hosting 鉁旓笍

@yubathom

This comment has been minimized.

Copy link
Collaborator

@yubathom yubathom commented 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.

@liyasthomas

This comment has been minimized.

Copy link
Owner Author

@liyasthomas liyasthomas commented Oct 31, 2019

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

@sabatesduran

This comment has been minimized.

Copy link

@sabatesduran sabatesduran commented 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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can鈥檛 perform that action at this time.