Skip to content
This repository has been archived by the owner on Oct 24, 2021. It is now read-only.

Guide v Docs #25

Closed
lorensr opened this issue May 22, 2016 · 3 comments
Closed

Guide v Docs #25

lorensr opened this issue May 22, 2016 · 3 comments
Labels

Comments

@lorensr
Copy link
Contributor

lorensr commented May 22, 2016

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.

@tmeasday
Copy link
Contributor

tmeasday commented May 22, 2016

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

@abernix
Copy link
Contributor

abernix commented May 26, 2016

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.

@filipenevola
Copy link
Collaborator

I'm closing this issue because it's too old.

If you think this issue is still relevant please open a new one.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

4 participants