-
Notifications
You must be signed in to change notification settings - Fork 3
snap-kit document structure #119
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
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 support@ekline.io. |
Published docs preview URL: https://devrev-preview-9400188f-a16c-4484-9b64-df9b70afd78f.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-8183f8db-bfd9-4455-ae60-1cbe4ffc5c6a.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-05e13d07-3de8-43d9-89c0-884580f15104.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-946c79e5-c8c6-45b5-b26d-7ab954a498e2.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-f0a8bd2e-d14b-4cb7-a83d-57a700a10b4f.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-c90dbd50-a208-43b5-a709-f3bf9062f469.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Number list input |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Email list input |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'Disabled') that defines people by their disability. (EK00030)
Inherited from [Disabled](#disabled): |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Static select"> |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'Disabled') that defines people by their disability. (EK00030)
Inherited from [Disabled](#disabled): |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Multi static select"> |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'Disabled') that defines people by their disability. (EK00030)
Inherited from [Disabled](#disabled): |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Toggle button"> |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Upload input"> |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- `placeholder` (optional): A [Plain text](#plain-text) element that defines the placeholder text shown on the element. |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'Disabled') that defines people by their disability. (EK00030)
Inherited from [Disabled](#disabled): |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Actions"> |
🚫 [EkLine] reported by reviewdog 🐶
Suggestions:
- Don't use language (such as 'disabled ') that defines people by their disability. (EK00030)
- `disable_on_action` (optional): A boolean indicating whether all elements in the actions block should be disabled when one of the elements is interacted with. When the action is completed, the elements are re-enabled. Defaults to `false`. A use case for enabling this is if you have multiple actions that shouldn't be executed concurrently or are incompatible with each other. An example of this would be a snap-in for selecting a meal for a company event. When the user selects a meal, the other meal options should be disabled until the order is placed. After that, the snap-kit can be updated with the information about the selection. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Checkboxes](#checkboxes) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Radio buttons](#radio-buttons) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Actions](#actions) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Static select](#static-select) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Multi static select](#multi-static-select) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Divider](#divider) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Tag picker](#tag-picker) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [User picker](#user-picker) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Part picker](#part-picker) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Toggle button](#toggle-button) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Upload input](#upload-input) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Form](#form) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Divider](#divider) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Content"> |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Rich text](#rich-text) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Divider](#divider) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Input layout](#input-layout) |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled_text` (optional): The text that's shown on hover if the component is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Radio buttons](#radio-buttons) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [User picker](#user-picker) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Part picker](#part-picker) |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Tag picker](#tag-picker) |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'Disabled') that defines people by their disability. (EK00030)
Inherited from [Disabled](#disabled): |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'Disabled') that defines people by their disability. (EK00030)
Inherited from [Disabled](#disabled): |
🚫 [EkLine] reported by reviewdog 🐶
Don't use language (such as 'disabled') that defines people by their disability. (EK00030)
- `disabled` (optional): Indicates whether the element is disabled. |
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
- Use the Oxford comma in 'deploying, deleting and upgrading'. (EK00039)
In this tutorial, you'll learn to create and deploy a snap-in. Additionally, you'll learn to create a snap-in version, installing from a version, deploying, deleting and upgrading the snap-in. |
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
- Remove 'separately ' if it's not important to the meaning of the statement. (EK00006)
Snap-ins are collections of objects that extend DevRev's core platform value. These objects include automation, event sources, keyrings, custom types, and vistas. Snap-ins are packaged and installed separately from the DevRev core platform. To create your own snap-in, create a [dev org](https://app.devrev.ai/) where you will be installing your snap-in. |
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
fern-api-docs/fern/docs/pages/start.mdx
Line 10 in 0523cfb
- Install [jq](https://stedolan.github.io/jq) |
🚫 [EkLine] reported by reviewdog 🐶
Use 'snap-in' instead of 'Snap-in'. (EK25050)
fern-api-docs/fern/docs/pages/start.mdx
Line 58 in 0523cfb
- `manifest` file defines the resources to be created on the DevRev platform. For detailed information on the various components of a manifest file, see [Snap-in Manifest](/snapin-development/references/manifest). |
Consider using 'snap-in' instead of 'snapin'. (EK25033)
fern-api-docs/fern/docs/pages/start.mdx
Line 70 in 0523cfb
2. On successful creation, the CLI automatically stores the package ID in its context corresponding to the slug. For more information, refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context). |
Consider using 'snap-in' instead of 'snapin'. (EK25033)
fern-api-docs/fern/docs/pages/start.mdx
Line 131 in 0523cfb
The CLI automatically stores the snap-in ID in its context. Refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context) section for more information. |
- `snap_in_id`: A unique identifier for the snap-kit. | ||
- `snap_in_action_name`: The name of the action this snap-kit represents. | ||
- `body`: An object that holds the actual snap-kit content in the form of `snaps`. | ||
- User interface elements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- User interface elements | |
- User interface elements. |
|
||
For example: | ||
- Form elements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Form elements | |
- Form elements. |
"body": { "snaps": [] } | ||
} | ||
``` | ||
- Layout elements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Layout elements | |
- Layout elements. |
``` | ||
- Layout elements | ||
|
||
- Data pickers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Data pickers | |
- Data pickers. |
- [Part Picker](#part-picker) | ||
- [Tag Picker](#tag-picker) | ||
- [User Picker](#user-picker) | ||
|
||
## Action payloads | ||
|
||
Snap-kit generates payloads when a user interacts with an actionable snap. The payload is sent to the backend and can be used to perform actions. The following snaps generate payloads: | ||
|
||
- [Button](#button) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Button](#button) | |
- [Button](#button). |
@@ -929,16 +759,16 @@ | |||
<Accordion title="Input"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
<Accordion title="Input"> | |
<Accordion title="Input">. |
- Email Input | ||
- Rich Text Input | ||
- Plain text input | ||
- Number input |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Number input | |
- Number input. |
- Rich Text Input | ||
- Plain text input | ||
- Number input | ||
- Email input |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Email input | |
- Email input. |
- Plain text input | ||
- Number input | ||
- Email input | ||
- Rich text input |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- Rich text input | |
- Rich text input. |
@@ -956,35 +786,34 @@ | |||
|
|||
Inherited from [Placeholder](#placeholder): | |||
|
|||
- `placeholder` (optional): A [Plain Text](#plain-text) element that defines the placeholder text shown on the element. | |||
- `placeholder` (optional): A [Plain text](#plain-text) element that defines the placeholder text shown on the element. | |||
|
|||
Inherited from [Disabled](#disabled): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
- [Content](#content) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using 'snap-in' instead of 'snapin'. (EK25033)
fern-api-docs/fern/docs/pages/start.mdx
Line 91 in 0523cfb
The CLI automatically stores the version ID in its context. Refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context) section for more information. |
Published docs preview URL: https://devrev-preview-d0e9383b-d2f6-4134-982a-4922d4a324a9.docs.buildwithfern.com |
I thought this change had been completed but apparently it got lost in the holidays. |
https://app.devrev.ai/devrev/works/TKT-15032