docs: revamp object customization docs #100
Conversation
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email [email protected]. |
|
Published docs preview URL: https://devrev-preview-3a0311df-baf0-4903-a345-fc7f1b991871.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-d0a979d3-f158-4792-9c29-8c44407742a2.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-f68009e5-4187-48e4-a602-e5b8bd57ace8.docs.buildwithfern.com |
fern/docs/pages/customization.mdx
Outdated
|
|
||
| ## Concepts | ||
| Subtypes are categories of DevRev object types. They inherit all fields from the parent | ||
| type and can include additional, specific fields. For example, an "Incident" subtype of |
There was a problem hiding this comment.
Suggest italics for types like this.
| type and can include additional, specific fields. For example, an "Incident" subtype of | |
| type and can include additional, specific fields. For example, an _Incident_ subtype of |
|
Published docs preview URL: https://devrev-preview-217cf95d-05cc-43f4-9ceb-c00d9cda2bfa.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-74442d52-590c-41bc-9529-c9e2e2be401e.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-18f51fa3-0b66-4c73-ad0f-46bd2849215d.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-87829a65-ebea-444c-a6c8-234ce2ae8251.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-31faf017-14fe-4ac7-a0eb-e162918e48a2.docs.buildwithfern.com |
|
|
||
| ## Concepts | ||
| Subtypes are kinds of DevRev object types. They inherit all fields from the parent type |
There was a problem hiding this comment.
| Subtypes are kinds of DevRev object types. They inherit all fields from the parent type | |
| Subtypes are flavors of DevRev object types. They inherit all fields from the parent type |
There was a problem hiding this comment.
I intentionally didn't use "flavor" here because it is informal. I was confused between "subtype being a kind of an object type" or "subtype categorising the object type" — turns out it's the former:
A "category" implies a group that contains multiple types, so an
animal category would include mammals, birds, reptiles, etc. A "kind"
refers to a specific type or instance within a category. In this
context, humans are a kind of animal (within the mammalian category)
rather than a separate category of animals.
I do use "bug-flavored issue" further down the doc.
|
Published docs preview URL: https://devrev-preview-a8571adb-1db2-4d6f-a31a-d56d9b9636de.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-da7e0d6a-24a5-4717-a347-69c13e2cc1b3.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-ca626226-0e0b-4a4c-a650-546df795fd44.docs.buildwithfern.com |
|
Published docs preview URL: https://devrev-preview-0219469e-30a6-4ca1-9b38-fd97ea3549d3.docs.buildwithfern.com |
https://app.devrev.ai/devrev/works/ISS-123073