Closed trulyronak closed 7 years ago
What do we gain from rehashing the README
into a static webpage?
I agree with @nickzuber , making this README into a static webpage isn't going to be much useful. The open sourced nature of this guide helps in making this guide what it is and Github is a really good place for expressing those open ideas. Also, it lets the original author have the credit when they come on this page. :smile:
I mean this doesn't mean the original owner loses credit. Furthermore, making it into a website (using mkdocs maybe) makes it more accessible and easier to read. Also, is there anything to lose BY making a website?
is there anything to lose BY making a website?
@ronakdev Yes — it'd add another layer of rather unnecessary maintenance. What would set the website iteration apart from this repo?
@nickzuber It will be updated automatically according to gh-pages
branch which @ronakdev has proposed (in case I'm thinking on similar lines).
@sahildua2305 What do you mean by "automatically"? Correct me if I'm wrong (since I haven't personally used gh-pages
before), but don't you still need to manually update the code in the branch whenever the README
is updated?
@nickzuber you just have to click a button. or, using mkdocs, we run a terminal command (mkdocs gh-deploy
)
@ronakdev Okay, so assuming that having a website adds absolutely no overhead or extra maintenance, I'm still not sold on why we want to make a website?
I personally don't think "because we can" is a strong argument either.
@ronakdev Thanks. It is a great suggestion to make a website.I'm adding +1 because If somebody wants to help this out then it will easy to find a page on GitHub instead of direct web page also.
Hey friends, I'm going to close this one. Appreciate the discussion, but having it as a straight GitHub repo makes it easier to maintain and edit over time. 😄
It's pretty simple (I have one already made on my fork), but I think it would be nice to publish this as a github page.
I can't push a seperate fork however, so if you could either 1. make a new branch called "gh-pages" so I can submit a pull request or publish this as a github page, that would be much appreciated 😄