bem-sdk-archive / bem-decl

:capital_abcd: Manage declaration of BEM entities. DEPRECATED →
https://github.com/bem/bem-sdk/tree/master/packages/decl
Other
11 stars 3 forks source link

Write purpose of the module #82

Open blond opened 7 years ago

qfox commented 7 years ago

Is this text enough for readme?

Operating with sets of bem-cells like reading, writing files with sets in different formats, adding one set to another, intersecting few sets, subtracting few sets from another, and so on.

I'm not sure what exactly we should write in docs in this section but I guess we should not keep issues opened without explicit description.

tadatuta commented 7 years ago

We have a document about decls in BEM] and there's a section called Algebra of declarations. So I think the description should refer to this document and tell about the purpose in general.

Knowledge about bem-cells and other implementation peculiarities should be described bellow.

qfox commented 7 years ago

Peculiarities ;-D So you think we need to write about bem-cell in this module? Prob we can do it in a README of bem-cell.

Cross linkage between bem-cell, bem-decl and bem.info is a good idea for sure.

Yeti-or commented 7 years ago

Personally I feel that we need to describe how to parse deps.js files here

qfox commented 7 years ago

Personally I feel that we need to describe how to parse deps.js files here

Why not to use @bem/deps?