Improve Getting started guide for snap-ins

[codeon]

No description provided.

[github-actions]

🌟 EkLine Reviewer

Hello! 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].

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

---

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 131 in e655057

- `src/test-runner/example.test.ts`

---

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 132 in e655057

- `src/functions/ticket_creator/index.test.ts`

---

⚠️ [EkLine] _{reported by reviewdog 🐶}

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

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 158 in e655057

...

[github-actions]

⚠️ [EkLine] _{reported by reviewdog 🐶}

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)

fern-api-docs/fern/docs/pages/start.mdx

Line 3 in e655057

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.

[github-actions]

🚫 [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 9 in e655057

- Install [DevRev CLI](/snapin-development/references/cli-install)

[github-actions]

🚫 [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 e655057

- Install [jq](https://stedolan.github.io/jq)

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Use 'snap-in' instead of 'Snap-in'. (EK25050)

fern-api-docs/fern/docs/pages/start.mdx

Line 58 in e655057

- `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).

[github-actions]

⚠️ [EkLine] _{reported by reviewdog 🐶}

Suggestions:

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

fern-api-docs/fern/docs/pages/start.mdx

Line 86 in e655057

...... ,

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 27 in e655057

- Install [DevRev CLI](/snapin-development/references/cli-install)

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 28 in e655057

- Install [jq](https://stedolan.github.io/jq)

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 29 in e655057

- Install [DevRev SDK](https://www.npmjs.com/package/@devrev/typescript-sdk?activeTab=readme)

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 130 in e655057

- `src/function-factory.ts`

[github-actions]

Published docs preview URL: https://devrev-preview-38b21fd2-dd4c-48e8-84d5-a1e3226ff839.docs.buildwithfern.com

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 131 in 91a6ba9

- `src/test-runner/example.test.ts`

[github-actions]

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 132 in 91a6ba9

- `src/functions/ticket_creator/index.test.ts`

[github-actions]

⚠️ [EkLine] _{reported by reviewdog 🐶}

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

fern-api-docs/fern/docs/pages/tutorials/timer-ticket-creator.mdx

Line 158 in 91a6ba9

...

[github-actions]

Published docs preview URL: https://devrev-preview-dd008a62-710d-4a85-a046-5c4b1220ea38.docs.buildwithfern.com

[github-actions]

⚠️ [EkLine] _{reported by reviewdog 🐶}

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)

fern-api-docs/fern/docs/pages/start.mdx

Line 1 in 7c37e31

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.

[github-actions]

Published docs preview URL: https://devrev-preview-ade75ef3-732a-4f10-aef1-67ecb1b9f6cd.docs.buildwithfern.com