docs(align-deps): update README#1931
Conversation
tido64
force-pushed
the
tido/align-deps/update-readme
branch
2 times, most recently
from
ff4d188 to
63b1622
Compare
tido64
force-pushed
the
tido/align-deps/update-readme
branch
from
63b1622 to
78f9c14
Compare
packages/align-deps/README.md
Outdated
| `@rnx-kit/align-deps` manages dependencies for an npm package, based on its | ||
| needs and requirements. |
There was a problem hiding this comment.
Consider expanding on this, explaining what align-deps does in some high-level detail, using words rather than code/bullets. A few sentences to contextualize it and introduce concepts like:
- aligning dependencies is important for compatibility
- built around preset, requirements, and capabilities (and briefly what these are and how they work together)
- ships with presets that capture real-world compatibility data, and is extensible so you can add your own
- you can use the command line, or get a richer experience through package configuration
- works well in monorepos and across them
There was a problem hiding this comment.
Then, below, when they read your examples and more technical info, they'll have a picture in mind of what it means and why it is the way it is.
There was a problem hiding this comment.
I added some more words, but I didn't want to make it too long. I know a lot of people just want to get started without having to read too much documentation. Maybe it makes more sense to forward people to https://microsoft.github.io/rnx-kit/docs/architecture/dependency-management somewhere?
There was a problem hiding this comment.
Sounds ok to me. Maybe put it at the end of the intro paragraph?
Then also update that guide so it has the right terminology :)
2 participants
Description
Update README.
Test plan
n/a