trigger.dev icon indicating copy to clipboard operation
trigger.dev copied to clipboard

docs: format Sequin embedding example

Open thinkverse opened this issue 2 months ago • 2 comments

✅ Checklist

  • [x] I have followed every step in the contributing guide
  • [x] The PR title follows the convention.
  • [x] I ran and tested the code works

Testing

I spun up the documentation locally, formatted the code, and tested the changed docs with FireFox and Google Chrome.


Changelog

Fix the format on the create-embedding-for-post.ts example in the Sequin guide.


Screenshots

[Before & After] Screenshot 2025-11-06 at 11 13 03 Screenshot 2025-11-06 at 11 13 37

💯

thinkverse avatar Nov 06 '25 10:11 thinkverse

⚠️ No Changeset found

Latest commit: aad9a90bd759b5ccf5debdefd7bc5c3513791079

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Nov 06 '25 10:11 changeset-bot[bot]

Walkthrough

This change updates documentation in docs/guides/frameworks/sequin.mdx to demonstrate a refactored task configuration syntax. The example for createEmbeddingForPost has been reformatted to use standard property keys (id, run) at the top level of the configuration object passed to the task() function, replacing the previous hyphenated key syntax (-id, -run). The underlying functional behavior and type definitions remain unchanged, with only the public declaration structure and layout modified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify that the new syntax example (task({ id, run: async (...) => {...} })) accurately reflects the current API
  • Confirm that the reformatted payload type definitions and re-indented schemas are correctly presented
  • Ensure the documentation change is consistent with any other examples in the codebase that may reference this task configuration pattern

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'docs: format Sequin embedding example' accurately and concisely summarizes the main change—formatting documentation code in the Sequin guide example.
Description check ✅ Passed The PR description follows the template structure with all required sections completed: checklist (all items checked), testing (documented local testing across browsers), changelog (concise description), and screenshots (before/after images provided).
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot] avatar Nov 06 '25 10:11 coderabbitai[bot]