Skip to content

feat(kno-12274): add guides in vue.js tutorial#1374

Open
scotidodson wants to merge 7 commits intomainfrom
sd-KNO-12274-add-vue-guides-tutorial
Open

feat(kno-12274): add guides in vue.js tutorial#1374
scotidodson wants to merge 7 commits intomainfrom
sd-KNO-12274-add-vue-guides-tutorial

Conversation

@scotidodson
Copy link
Copy Markdown
Contributor

KNO-12274: [Docs] Add guides in Vue tutorial

Summary

  • Adds a new "community-sourced" tutorial for implementing Knock guides in Vue.js, based on the existing Notion doc a few customers have used.
  • Adds a "Guide identifiers" section to the rendering guides doc (channel ID, guide key, guide type)
  • Adds in-app guide as a destination channel type in the integrations overview and channels concept pages

Changes

  • content/tutorials/guides-in-vue.mdx — new tutorial on implementing guides in Vue.js
  • data/sidebars/tutorialsSidebar.ts — added sidebar entry for tutorial page
  • components/ui/Callout.tsx — added community_sourced type with fixed title and body copy via COMMUNITY_CONTENT constant; idea is that this will always have the same copy every time it's used and we expect to use it again on other tutorials.
  • components/ui/CodeBlock.tsx — registered vue as a syntax highlighting language (aliased to xml/hljs, which handles Vue SFC template syntax)
  • content/in-app-ui/guides/render-guides.mdx — added "Guide identifiers" section explaining guide channel ID, guide key, and guide type based on some recent customer confusion
  • content/integrations/overview.mdx — added in-app guide to the destination channels list
  • content/concepts/channels.mdx — added in-app guide to the destination channels list

Notes

  • TypeScript types for guide steps are loosely typed (unknown) in places where the exact exported types from @knocklabs/client are unclear — we may want to change that.
  • Follow-up ticket filed for rethinking in-app channel coverage in the integrations section: KNO-12277

@linear
Copy link
Copy Markdown

linear bot commented Mar 30, 2026

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 31, 2026 3:29pm

Request Review

@scotidodson scotidodson requested a review from a team March 30, 2026 21:55
Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk HIGH: Adds a new Vue.js guides tutorial with modifications to shared UI components (Callout.tsx and CodeBlock.tsx), sidebar navigation, and content across multiple documentation sections.

Reasons

  1. Shared component modified (Callout.tsx). Adds a new community_sourced callout type with a COMMUNITY_SOURCED constant containing hardcoded title/body, and refactors title/text rendering to use effectiveTitle/effectiveText — this affects all existing callout usage site-wide.
  2. Shared component modified (CodeBlock.tsx). Registers vue as a new syntax highlighting language aliased to xml, which changes the set of recognized languages in all code blocks across the site.
  3. New MDX page added. content/tutorials/guides-in-vue.mdx is a brand new 469-line tutorial file — new pages carry MEDIUM risk on their own (routing, SEO, sidebar integration).
  4. Sidebar navigation modified. data/sidebars/tutorialsSidebar.ts adds a new entry, which affects the tutorials section navigation for all readers.
  5. Changes span multiple documentation sections. Edits touch content/concepts/, content/integrations/, content/in-app-ui/, and content/tutorials/, increasing the surface area of potential issues.

Notes

  • Callout.tsx rendering logic. The refactor from direct title/text props to effectiveTitle/effectiveText should be tested to confirm that existing callout types still render correctly when title or text is explicitly passed as undefined or null.
  • CodeBlock.tsx language alias. Verify that aliasing vue to xml produces acceptable syntax highlighting for Vue SFC templates — .vue files contain <script>, <style>, and <template> blocks that may not all highlight correctly with plain XML grammar.
  • TypeScript loose typing. The PR description notes that guide step types use unknown in several places — a reviewer should assess whether stronger typing is feasible with the current @knocklabs/client exports.
  • New tutorial content quality. At 469 lines, this is a substantial tutorial. Review for adherence to the style guide (sentence case, active voice, no adverbs, Oxford comma, American spelling, link validity).
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant