Crucial Documentation For Beginners

[ardan-bkennedy]

Been talking to Sam as I continue to use the new dep tool. People new to the idea of vendoring code have a real challenge in understanding what they are doing. Even worse, they don't know what to expect from the tooling and can't verify things on their own. Since the tooling is new this could be important for everyone.

I think three documents need to be written.

Doc 1: A history of dependency management that includes the major approaches that people/languages take. Describe why dep is choosing vendoring and the saving of those dependencies with the project code.

Doc 2: Mechanics of vendoring and the mechanics of the tooling. This gives people an understand of how things work.

Doc 3: Design and guidelines. This gives people the best practices and approaches to take. This shows the tooling in action on real projects and packages.