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.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Oct 24, 2021. It is now read-only.
Let's add a guideline to Contributing.md saying what stuff to put where
Generally docs is what it does, and guide is opinionated long form ("articles") on how to use it? But guide has a good bit of "what it does" too, eg build tool section, mobile.
For example, this should be docs because it's "what it does"? meteor/guide#457
And we've got some overlap, eg with modules, which we should probably keep down, but it makes sense for long form articles to sometimes include information from the docs.
The text was updated successfully, but these errors were encountered:
It's tricky. Also because the docs existed before the guide, there is a bit of explanatory content in there which probably doesn't really belong in that format.
I think the basic idea is the docs is "just the facts" which includes a lot more detail and completeness around options / edge cases / whatever. The guide is opinionated and tells you more or less just what you need to know to do it in the recommended way.
With that in mind I tend to agree with you about guide#457
Yeah, I agree that meteor/guide#457 (my own issue) should be docs too. There wasn't really a reasonable place in the docs for it. All the information about NPM use was in Guide.
Let's add a guideline to Contributing.md saying what stuff to put where
Generally docs is what it does, and guide is opinionated long form ("articles") on how to use it? But guide has a good bit of "what it does" too, eg build tool section, mobile.
For example, this should be docs because it's "what it does"? meteor/guide#457
And we've got some overlap, eg with modules, which we should probably keep down, but it makes sense for long form articles to sometimes include information from the docs.
The text was updated successfully, but these errors were encountered: