Documentation and overall project readability is lacking

[Alexangelj]

The Primitive protocol contracts live as different versions, with different parts scattered about. It's confusing, what's in use right now? What's being used? What's being thrown away?

There needs to be consistent documentation and guides for developers to interact with the protocol, and for third party security experts to be able to easily examine the production code.

Defi Safety has a great list of basic to do items. These should all be done.

Open Zeppelin has a good checklist

There should be consistency between the documentation, website, and github repo. The source of truth should always be the docs! Documentation should link to the implementation code.

There should be individual (small) guides on how to use each function of the protocol/what they do.