feat: deny missing docs

[joshua-mo-143]

• [x] I have looked for existing issues (including closed) about this

Feature Request

We should be ensuring reasonable efforts are made to cover documentation by denying missing documentation.

Motivation

Documentation is often one of the first ports of call for users when things go wrong, and by adding relevant documentation, we can ensure users have full clarity on how (not) to use a given import.

Proposal

Alternatives

[linear[bot]]

RIG-752 feat: deny missing docs

[0xMochan]

I'm kinda thinking about whether we should move the rig-docs to this repo directly instead of a separate repo and use the standard rust-book style of docs for simplicity. it would make it easier to bundle docs with new feature PRs and should make it easier for contributors as well alongside making it more consistent with the rust ecosystem.

ofc, i don't want to introduce change for change's sake but it was something I was pondering about.

[joshua-mo-143]

Closing as this is basically impossible without #699, but I don't think this is something that we should be actively enforcing (...yet).