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
Closed

Use Github Wiki instead of a docs folder #191

nhooyr opened this issue Mar 11, 2019 · 4 comments
Labels
docs Documentation related

Comments

@nhooyr
Copy link
Contributor

nhooyr commented Mar 11, 2019

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

@nhooyr nhooyr added the docs Documentation related label Mar 11, 2019
@MichaelDesantis
Copy link
Contributor

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.

@MichaelDesantis
Copy link
Contributor

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

@nhooyr
Copy link
Contributor 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
Copy link
Contributor

nol166 commented Mar 11, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

No branches or pull requests

3 participants