Skip to content

Add the rule descriptions directly in the validation report.  #1364

@isabelle-dr

Description

@isabelle-dr

Describe the problem

Currently, when the users open the HTML report, it is difficult to understand what the problems are; the users need to guess from the notice name.
Often, they don't see the link to the documentation provided in the text:
Please find this notice description here.

Proposed solution

We should include the descriptions directly in the validator output (JSON and interface) so that the user doesn't necessarily need to go back and forth between the report and the documentation.
We should still keep the link to the documentation, for the cases where the users want to know more (where is the spec requiring this? how do I fix this?)

This work depends on #1324 and all the work @bdferris is currently doing to solve this issue (#1362, #1361, #1346, #1345)

Alternatives you've considered

No response

Additional context

Current interface - no way of knowing what the problem is besides the notice name.

Screenshot 2023-03-24 at 6 11 07 PM

Metadata

Metadata

Labels

enhancementNew feature request or improvement on an existing featurestatus: BlockedCan't work on it currently because of an external factor.

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions