search

benawad / dogehouse

Taking voice conversations to the moon 🚀
https://dogehouse.tv/
MIT License
9.12k stars 1.48k forks source link

Enable Wikis #1365

Open f1shy-dev opened 3 years ago

f1shy-dev commented 3 years ago

Is your feature request related to a problem? Please describe. I think we should enable Wikis in this project, so we can make easy to follow guidelines for contributing/editing. For example, multiple people frequently ask how to add languages, so a Wiki page about that would make it simpler!

Describe the solution you'd like @benawad needs to enable Wikis in this repo, and also make it so people can contribute to them.

Describe alternatives you've considered We could just make .md files with all of the information (we kinda do this already), but that's not really a good solution if there is already a built-in wikis feature.

HarrisonMayotte commented 3 years ago

I agree and disagree at the same time. I think there are benefits to both approaches and I think it would make more sense for now to have the .md files, but I'm not opposed to the Wiki either. I just think that the wiki has to be maintained by collaborators rather than just any contributor due to the way github works.

f1shy-dev commented 3 years ago

Yeah I guess, not really sure what to do, I guess we wait for Ben's view on this.

violetcrein commented 3 years ago

I think Ben needs to do this

HonbraDev commented 3 years ago

Based on the conversation, I think we should have MarkDown files because anyone can contribute.

violetcrein commented 3 years ago

@HonbraDev markdown is one word

mmattbtw commented 3 years ago

We could do a GitBook, which has GitHub integration and uses markdown, so you can sync your GitBook wiki to a GitHub repo, and people can contribute on GitHub, which will automatically upload to the GitBook wiki.

violetcrein commented 3 years ago

I think wikis are good or just plain markdown

HarrisonMayotte commented 3 years ago

I would say GitBook would make sense just because it would allow more people than just collaborators to work on it but it would still be controlled because the changed would have to go through the same PR process.

HarrisonMayotte commented 3 years ago

It's up to @benawad though.

violetcrein commented 3 years ago

yes

HarrisonMayotte commented 3 years ago

All collaborators can enable them but it's about whether or not that's the commitment we want to make because it's either all in on wikis, all in on Gitbook, or all in on whatever other thing we decide to use for the information management.

violetcrein commented 3 years ago

how can we?

TheOtterlord commented 3 years ago

I think embeding the docs in the codebase as markdown files would work better, as then anyone can edit it, but it is all moderated by the PR system

f1shy-dev commented 3 years ago

GitBook could work, but whatever we do it's still up-to @benawad.

HonbraDev commented 3 years ago

@ofsho autocorrect

violetcrein commented 3 years ago

@HonbraDev what?

HonbraDev commented 3 years ago

I replied to a notofication on my phone, it seems that you deleted the message. It was about MarkDown being one word.

violetcrein commented 3 years ago

oh ok

imadill commented 3 years ago

So... Did Ben said anything about this matter? I was thinking to open a issue to close the Wiki tab because that was unused until I found this issue.

TheOtterlord commented 3 years ago

He's not commented on this yet no. I doubt we'll end up using wikis as then only collaborators can edit it. For anyone wishing to contribute documentation, do so in ./docs for now