diff --git a/docs/connector-development/ux-handbook.md b/docs/connector-development/ux-handbook.md index e640ea7dda77b..f0c1fcad400e0 100644 --- a/docs/connector-development/ux-handbook.md +++ b/docs/connector-development/ux-handbook.md @@ -187,6 +187,10 @@ Adding a parameter “attribution\_lookback\_window” with no explanation might If a user needs to obtain an API key or host name, tell them exactly where to find it. Ideally you would show them screenshots, though include a date and API version in those if possible, so it’s clear when they’ve aged out of date. +**Links should point to page anchors where applicable**. + +Often, you are trying to redirect the user to a specific part of the page. For example, if you wanted to point someone to the "Input Configuration" section of this doc, it is better to point them to `https://docs.airbyte.com/connector-development/ux-handbook#input-configuration` instead of `https://docs.airbyte.com/connector-development/ux-handbook`. + **Fail fast & actionably** A user should not be able to configure something that will not work. If a user’s configuration is invalid, we should inform them as precisely as possible about what they need to do to fix the issue.