Skip to content
This repository has been archived by the owner on Apr 14, 2023. It is now read-only.

Have links to specific documentation included in validation issue messages #1689

Open
matthewdunsdon opened this issue Jul 17, 2020 · 0 comments
Labels
enhancement Issues related to improving the codebase, the documentation or process within the project

Comments

@matthewdunsdon
Copy link
Contributor

Feature request

Seems like for many validation issue messages the field and constraint type is known, so there is no reason why the messages could not provide a link to some specific part of the documentation.

There does not seem to be a predictable URL pattern for getting to specific documentation, so maybe another piece of investigation needs to be done so that there can be some long-term stable urls for getting to the documentation of a particular field or constraint.

I expect this could help both with the users of the online playground or with the tool directly, who are not profile experts and need help fixing errors.

@matthewdunsdon matthewdunsdon added the enhancement Issues related to improving the codebase, the documentation or process within the project label Jul 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Issues related to improving the codebase, the documentation or process within the project
Projects
Product roadmap
  
Approved
Development

No branches or pull requests

1 participant