Skip to content

Commit

Permalink
Add section to UX handbook about pointing to page anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
sherifnada authored Jan 18, 2022
1 parent edc0925 commit 032b06d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/connector-development/ux-handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 032b06d

Please sign in to comment.