search

componentjs / spec

Component specs
34 stars 4 forks source link

docs #20

Closed jonathanong closed 10 years ago

jonathanong commented 10 years ago

https://github.com/component/component/issues/383

i think there should be a "docs": [] array in component.json, and component install should install components with the docs. what do you guys think? would be nice to be able to view the docs locally if we're not connected to the internets or something

dominicbarnes commented 10 years ago

Perhaps docs can be part of the development hash? (or at least only downloaded with the --dev flag)

I imagine I would not want docs to be built unless I'm actively developing.

jonathanong commented 10 years ago

well the idea is to include docs when installing. when installing a component, development stuff shouldn't be touched at all.

i think it's only useful if you've lost internet connection, so i'm meh about this. @micky2be?

dominicbarnes commented 10 years ago

imo, I think we need to leave docs out of component. It's a whole other thing to spec/support, and I think we have bigger problems to solve.

jonathanong commented 10 years ago

i agree. sorry @micky2be haha.

micky2be commented 10 years ago

No trouble there. It's just that my apps have a tool to read documentation of dependencies and it would have been helpful to get me components dependencies documentation