Skip to content

Move the LLM prompt to frontmatter#2860

Merged
NWylynko merged 2 commits intomainfrom
nick/move-llm-prompt-to-frontmatter
Jan 14, 2026
Merged

Move the LLM prompt to frontmatter#2860
NWylynko merged 2 commits intomainfrom
nick/move-llm-prompt-to-frontmatter

Conversation

@NWylynko
Copy link
Contributor

@NWylynko NWylynko commented Dec 8, 2025

🔎 Previews:

What does this solve?

image

Once https://github.com/clerk/clerk/pull/1837 is merged, users on the new docs actions locations will see the actions right above the <LLMPrompt /> component. But this creates two issues:

  • Visually this looks odd, having the title, then buttons, then a larger callout component, the hierarchy is off
  • These two sets of actions seem to the average reader to do the same thing, both literally have "Open in Cursor"

What changed?

  • This moves to defining the llm prompt component in the frontmatter, making it a config instead of content.
  • Now the guide actions (open in x, copy markdown) don't show up if llm is defined in the frontmatter.

We are effectively treating the llm prompt as an upgrade over the guides actions, if its defined then we want to hide the guide actions as to not cause confusion.

Checklist

This pr does not need to be merged before https://github.com/clerk/clerk/pull/1837, but it will need to be merged before the feature flag gets enabled / rolled out to 50% of people.

@vercel
Copy link

vercel bot commented Dec 8, 2025

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

Project Deployment Review Updated (UTC)
clerk-docs Ready Ready Preview Jan 6, 2026 3:53pm

@NWylynko NWylynko requested a review from manovotny January 6, 2026 16:16
@NWylynko NWylynko marked this pull request as ready for review January 6, 2026 16:17
@NWylynko NWylynko requested a review from a team as a code owner January 6, 2026 16:17
@manovotny
Copy link
Contributor

manovotny commented Jan 6, 2026

I don't know if I like treating it as an override. You lose the ability to copy markdown and work with any other LLM besides Cursor.

What if the buttons move below the larger callout?

@NWylynko
Copy link
Contributor Author

NWylynko commented Jan 6, 2026

I don't know if I like treating it as an override. You lose the ability to copy markdown and work with any other LLM besides Cursor.

I recon we should update the "Open in Cursor" in the <LLMPrompt /> to be a dropdown of llm options, so your not like forced to use cursor.

And possibly we add a button next to the "edit in github" button at the bottom of the page of "view raw markdown" that opens the /raw url for the guide.

What if the buttons move below the larger callout?

Thats an option, but I still feel like will confuse people

@manovotny
Copy link
Contributor

I recon we should update the "Open in Cursor" in the <LLMPrompt /> to be a dropdown of llm options, so your not like forced to use cursor.

I can see that. Big, bold callout with Open in, Copy prompt, Copy markdown buttons. Could even do Open in and Copy (with Prompt and Markdown) dropdowns.

Copy link
Contributor

@manovotny manovotny left a comment

Choose a reason for hiding this comment

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

Contradicting myself and approving.

Longer story: Nick and I met and discussed what I was asking for earlier. Thing is:

  1. None of the other items in the Open in list are IDEs where you'd be doing coding with a custom prompt like this except for Cursor. We could look to add others like VS Code and Zed as a future feature separate from the PR.
  2. Further, opening that prompt into an AI client (i.e. ChatGPT) does basically nothing. The LLM says "Got it." because it's not capable of performing a coding task like the prompt guides.

Based on that, it makes sense to only render the LLM prompt or the LLM actions, not both (at least at this time).

@NWylynko NWylynko merged commit c5dc70b into main Jan 14, 2026
8 checks passed
@NWylynko NWylynko deleted the nick/move-llm-prompt-to-frontmatter branch January 14, 2026 13:12
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.

2 participants