Skip to content

docs: update customization UI hints #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions fern/docs/pages/customization.mdx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

This guide provides an overview of the customization framework and walks you through the process of tracking bugs in your organization. By the end of this guide, you'll be able to:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

In general, don't use an ellipsis. (EK00011)

"created_by": {...},

Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,10 @@ hints:
* `placeholder`: The placeholder text for the field.
* `is_sortable`: Whether the field is sortable. Requires `is_filterable` to be true.
* `is_groupable`: Whether the field is groupable. Requires `is_filterable` to be true.
* `order`: The order in which the field appears in the side panel.
* `group_name`: The group title under which field(s) appear in the side panel. In the example below, the fields are grouped under groups titled **Group 1** and **Group 2**.

![customization-group_name-ui-hint](../img/customization-group_name-ui-hint.png)

<Callout intent="tip">
`is_filterable` is not a UI hint but a top level field property.
Expand Down Expand Up @@ -651,3 +655,7 @@ The `effects` array contains the list of effects of the condition. The following
`don:core:dvrv-us-1:devo/test:stage/5` is the ID of the _completed_ stage. The
stage display name is not used in the expression because it is liable to change.
</Callout>

Constraints on stock fields can only be strengthened.
For example, a required stock field cannot be made optional, and a hidden stock
field cannot be made visible.
Loading