[DOC-349] Updated documentation including links to examples

[sitvanit83]

Link to generated documentation

[mdgeorge4153]

Some comments. Please also check that the CI is passing (looks like there is a typo), and add the link to the generated documentation to the PR comment (see the instructions in the default PR comment template).

[mdgeorge4153]

Another round of comments.

I think the biggest thing is that some of the examples need some context - see my comment on defs.md for an example of what I mean.

For the examples that we expect to describe fully in the user guide (like the ERC20 examples linked to for rules, assert, and require statements), I wonder if it might be better to put a placeholder outline in the "Spec by Example" section of the user guide and move the example links there. Maybe it should be a separate PR though.

[nd-certora]

overall good, a few comments and requests to do a bit more cleaning

[mdgeorge4153]

Looks like a bunch of the links got broken so I can't view the generated documentation. Can you fix them and re-request review?

Thanks

[mdgeorge4153]

Overall looking good, here's another round of edits.