-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Use GitHub's Wiki for all docs #401
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
Comments
#191 was closed before? Are we going with this now? |
I'll be assigning this to myself. Porting the docs should be easy to do. |
Yea I'm not sure if this is the best move considering translations/versions will be hard to manage when the docs are not managed directly with the source code. Deferring to @code-asher. |
It's actually trackable since the wiki itself is a Git Repository @nhooyr |
It is, but it gets harder to manage since the wiki will be a different repository and so you'll have to remember to always update the wiki as the features get updated instead of managing all of that in a single PR/repository. |
We can actually have the docs be a link to the wiki version and we can just push from |
It sounds like if I have a feature branch that also has doc changes I'd have to maintain two PRs in separate repos for the same feature which doesn't sound like a super fun time to me. I also don't like that if I go back through code-server's history I don't also get the documentation for code-server at that point in time. |
From what I can see we can definitely have pushing to the Wiki page automated via |
At that point, why not just let people browse docs directly? The Wiki doesn't add anything other than a table of contents. |
Hmm I'm not really seeing the gain here either. 🤔 |
Based on internal discussion, we just disabled Wiki. Closing. |
https://www.growingwiththeweb.com/2016/07/enabling-pull-requests-on-github-wikis.html
The workaround presented in that article makes it a very elegant model.
The text was updated successfully, but these errors were encountered: