Skip to content

Commit a3da99f

Browse files
shivanshtilenkavcic
authored andcommitted
Document unit and is_read_only customization UI hints (#248)
- Use imperative tense in headings. This has been done in the custom objects documentation. - Use smaller image for group_name UI hint.
1 parent 33c6cf2 commit a3da99f

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed
Loading
8.7 KB
Loading

fern/docs/pages/customization.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ _issue_ would have all _issue_ fields plus _bug_-specific fields like _RCA_.
4747

4848
Subtypes are defined using a schema fragment of type `custom_type_fragment`.
4949

50-
## Customizing a DevRev object
50+
## Customize a DevRev object
5151
<Callout intent="note">
5252
Your team needs to track software bugs. You want to know:
5353
- Which environments are affected (development, testing, production)
@@ -388,7 +388,7 @@ The object now references the latest fragment version (`custom_type_fragment/2`)
388388
the optional release notes field is absent, the tenant fragment remains attached,
389389
allowing for future tenant-specific field additions.
390390

391-
## Deprecating a custom schema fragment
391+
## Deprecate a custom schema fragment
392392

393393
Custom schema fragments can be deprecated to avoid creating work items using them. The
394394
following POST request payload to `schemas.custom.set` can be used:
@@ -406,7 +406,7 @@ following POST request payload to `schemas.custom.set` can be used:
406406
}
407407
```
408408

409-
## Listing custom schema fragments
409+
## List custom schema fragments
410410

411411
The following API call can be used to list all the custom schema fragments in your
412412
organization:
@@ -431,10 +431,16 @@ hints:
431431
* `is_sortable`: Whether the field is sortable. Requires `is_filterable` to be true.
432432
* `is_groupable`: Whether the field is groupable. Requires `is_filterable` to be true.
433433
* `order`: The order in which the field appears in the side panel.
434+
* `is_read_only`: Whether the field is read-only in the UI. Once the object is created, this
435+
field cannot be updated in the UI.
434436
* `group_name`: The group title under which field(s) appear in the side panel. In the
435437
example below, the fields are grouped under groups titled **Group 1** and **Group 2**.
436438

437439
![customization-group_name-ui-hint](../img/customization-group_name-ui-hint.png)
440+
* `unit`: The unit for the field. For example, days, kg. The unit is displayed
441+
in the side panel as shown below:
442+
443+
![customization-unit-ui-hint](../img/customization-unit-ui-hint.png)
438444

439445
<Callout intent="tip">
440446
`is_filterable` is not a UI hint but a top level field property.
@@ -535,7 +541,7 @@ and _closed_ states in your organization.
535541
You want to add a new stage _Needs RCA_ to the _bug_ subtype.
536542
</Callout>
537543

538-
### Adding a custom stage
544+
### Add a custom stage
539545

540546
```curl
541547
curl --location 'https://api.devrev.ai/stages.custom.create' \
@@ -622,7 +628,7 @@ curl --location 'https://api.devrev.ai/stage-diagrams.create' \
622628
It is important to specify the start stage for the diagram. This is the default stage that gets assigned to the newly created objects.
623629
</Callout>
624630

625-
### Using a stage diagram
631+
### Apply a stage diagram
626632

627633
The stage diagram created above can be referenced in the _bug_ subtype as follows:
628634

0 commit comments

Comments
 (0)