[Docs]: Add rich warning reporting to compiler docs

### Documentation Type

Missing documentation

### Documentation Location

API documentation for check/compile API

### Issue Description

Warning behaviour not explained

### Suggested Improvement

Describe how and why warnings might be generated, and how to debug using rich warning rendering.

### Additional Context

_No response_