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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Github Wiki instead of a docs folder #191

Closed
nhooyr opened this Issue Mar 11, 2019 · 4 comments

Comments

Projects
None yet
3 participants
@nhooyr
Copy link
Collaborator

nhooyr commented Mar 11, 2019

Would make it much easier for the community to contribute versus creating PRs.

@nhooyr nhooyr added the docs label Mar 11, 2019

@Multishifties

This comment has been minimized.

Copy link
Contributor

Multishifties commented Mar 11, 2019

Out of curiosity how would this approach compare to a dedicated docs folder in regards to the following:

Ease of maintenance.
Ability/ease of community contributions.
Versioning.
Supporting multiple versions and translations.
Should the worst happen, the ability to roll back a bad release.
Organization.
etc.

@Multishifties

This comment has been minimized.

Copy link
Contributor

Multishifties commented Mar 11, 2019

Tagging related existing issues here:
#187
#17
#47
#145
(ok, really just every issue with a docs tag)

@nhooyr

This comment has been minimized.

Copy link
Collaborator Author

nhooyr commented Mar 11, 2019

That is a fair point. Versioning/translations would unfortunately not really be possible.

The GitHub wiki is itself a git repo so we could always create a branch on it and document how to clone/read it but that's pretty janky.

So not sure we should go down this route anymore.

@nol166

This comment has been minimized.

Copy link
Collaborator

nol166 commented Mar 11, 2019

Just pushed an update for the docs. Once they are reviewed they should be ready for prod.

@nhooyr nhooyr closed this Mar 12, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.