Skip to content

Commit 5a43609

Browse files
authored
Update customization doc headings to imperative tense (#261)
1 parent 6a1ddf3 commit 5a43609

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

fern/docs/pages/custom-objects.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Let's say you want to manage marketing campaigns on DevRev. This guide goes thro
2323

2424
All DevRev objects require a schema. First, create a schema for the "Campaign" custom object. Make sure to replace the `<TOKEN>` with your API token.
2525

26-
### Create a schema and a custom object
26+
### Create custom objects
2727

2828
```curl
2929
curl --location 'https://api.devrev.ai/schemas.custom.set' \
@@ -127,7 +127,7 @@ Note that the `id` field in the above response is the system generated unique ID
127127

128128
The sections below provide more details on the available API endpoints for interacting with custom objects.
129129

130-
### Get a custom object
130+
### Get custom objects
131131

132132
To get a custom object, use the `custom-objects.get` endpoint:
133133

@@ -160,7 +160,7 @@ curl --location 'https://api.devrev.ai/custom-objects.list' \
160160
}'
161161
```
162162

163-
### Update a custom object
163+
### Update custom objects
164164

165165
To update an existing custom object, use the `custom-objects.update` endpoint. The
166166
following example updates the budget of the previously created campaign custom object:
@@ -178,7 +178,7 @@ curl --location 'https://api.devrev.ai/custom-objects.update' \
178178
}'
179179
```
180180

181-
### Delete a custom object
181+
### Delete custom objects
182182

183183
To delete a custom object, use the `custom-objects.delete` endpoint.
184184
The following example deletes the previously created campaign custom object:

fern/docs/pages/customization.mdx

Lines changed: 10 additions & 10 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-
## Customize a DevRev object
50+
## Customize DevRev objects
5151
<Callout intent="note">
5252
Your team needs to track software bugs. You want to know:
5353
- Which environments are affected (development, testing, production)
@@ -226,7 +226,7 @@ The following custom field types are supported -
226226
The list variants of all the supported custom field types are also supported.
227227
In the example above, the `impacted_environments` field is a list of enum values.
228228

229-
## Filtering DevRev objects
229+
## Filter DevRev objects
230230

231231
<Callout intent="note">
232232
To demonstrate filtering capabilities, consider finding all bugs in the 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-
## Deprecate a custom schema fragment
391+
## Deprecate custom schema fragments
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:
@@ -419,7 +419,7 @@ curl --location 'https://api.devrev.ai/schemas.custom.list' \
419419

420420
Deprecated fragments aren't listed in the response.
421421

422-
## UI hints
422+
## Configure UI hints
423423

424424
UI hints allow customizing the UI/UX of custom fields. So far, `ui.display_name` has
425425
been used to set the display name of a field. Let's look at the other supported UI
@@ -446,7 +446,7 @@ hints:
446446
`is_filterable` is not a UI hint but a top level field property.
447447
</Callout>
448448

449-
## Stock field overrides
449+
## Override stock fields
450450

451451
The fields available in native DevRev objects are called stock fields. For example,
452452
`priority` is a stock field of _issue_.
@@ -514,7 +514,7 @@ A few observations can be made from the above payload:
514514
If you want the overrides to be scoped to a subtype, you can add them to the subtype
515515
instead.
516516

517-
## Stage customization
517+
## Customize stages
518518

519519
Stages represent the different phases an object can be in during its lifecycle. For
520520
example, an issue might go through the following lifecycle:
@@ -541,7 +541,7 @@ and _closed_ states in your organization.
541541
You want to add a new stage _Needs RCA_ to the _bug_ subtype.
542542
</Callout>
543543

544-
### Add a custom stage
544+
### Create custom stages
545545

546546
```curl
547547
curl --location 'https://api.devrev.ai/stages.custom.create' \
@@ -558,7 +558,7 @@ A stage can be referenced by any object type. For example, both _issue_ and _tic
558558
object types can use the _in_development_ stage. It's incorrect to say that the stage is
559559
bound to an _issue_ or _ticket_.
560560

561-
### Stage diagram
561+
### Create stage diagrams
562562

563563
A stage diagram determines the allowed transitions between stages for a given object.
564564
For example, _triage_ stage can transition to _backlog_ stage but not vice versa.
@@ -628,7 +628,7 @@ curl --location 'https://api.devrev.ai/stage-diagrams.create' \
628628
It is important to specify the start stage for the diagram. This is the default stage that gets assigned to the newly created objects.
629629
</Callout>
630630

631-
### Apply a stage diagram
631+
### Apply stage diagrams
632632

633633
The stage diagram created above can be referenced in the _bug_ subtype as follows:
634634

@@ -649,7 +649,7 @@ curl --location 'https://api.devrev.ai/schemas.custom.set' \
649649

650650
All objects of the _bug_ subtype now adhere to the stage diagram created above.
651651

652-
## Dependent fields
652+
## Configure dependent fields
653653

654654
<Callout intent="note">
655655
The developers in your organization tend to forget to add an RCA when resolving the

0 commit comments

Comments
 (0)