FAQ on what happens when i use a coding agent#2799
FAQ on what happens when i use a coding agent#2799annabellscha wants to merge 2 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@claude review |
There was a problem hiding this comment.
LGTM — clean docs-only addition; the tag placement nit is captured in the inline comment.
Extended reasoning...
Overview
This PR adds a new FAQ file explaining what the Langfuse agentic onboarding does automatically, and wires it into the agent-skill docs page via the existing FaqPreview component. Two files changed: the agent-skill page gains an FAQ section (4-line diff), and a new 58-line FAQ MDX file is created.
Security risks
None. This is purely documentation content with no code logic, auth, or data handling.
Level of scrutiny
Low. Both changes are documentation-only. The FaqPreview component usage follows the established pattern already used across other get-started pages. The new FAQ content is clear, accurate, and well-structured.
Other factors
One nit was found regarding the tags observability-get-started and prompt-management-get-started surfacing this educational article inside troubleshooting sections — this is captured as an inline comment. The concern is real but minor and editorial in nature; whether it warrants a tag change is up to the author. The core purpose of the PR (adding the FAQ to the agent-skill page) is correct and complete.
| --- | ||
| title: What happens when I use Langfuse's agentic onboarding with a coding agent? | ||
| description: Learn what Langfuse's coding-agent onboarding does automatically for tracing and prompt management. | ||
| tags: [agent-skill, observability-get-started, prompt-management-get-started] |
There was a problem hiding this comment.
🟡 The new FAQ's tags observability-get-started and prompt-management-get-started will surface this informational how-it-works article inside the "Not seeing what you expected?" troubleshooting sections of the observability and prompt-management get-started pages, which is a content mismatch. Consider removing those two tags if the FAQ is only intended for the agent-skill page. Note: the concern about a 404 on the agent-skill tag page is not valid — page.tsx has a dynamic fallback (lines 43-58) and generateStaticParams (lines 222-233) auto-generates routes for any tag found in FAQ frontmatter, so /faq/tag/agent-skill will resolve correctly.
Extended reasoning...
Content placement mismatch via get-started tags
The new FAQ file agentic-onboarding-with-coding-agents.mdx carries three tags: agent-skill, observability-get-started, and prompt-management-get-started. The FaqPreview component (components/faq/FaqPreview.tsx:19) filters FAQ pages by checking if any of a page's tags match the requested tag. Because observability/get-started.mdx (line 425) calls <FaqPreview tags={["observability-get-started"]} /> and prompt-management/get-started.mdx (line 127) calls <FaqPreview tags={["prompt-management-get-started"]} />, the new article will appear in both of those pages' "Not seeing what you expected?" sections.
Those sections exist as troubleshooting helpers — their current FAQs are things like "I have setup Langfuse but do not see traces", "empty trace input/output", "old prompt version caching". The new article is an educational how-it-works piece explaining what the coding-agent onboarding does automatically. It answers a different class of question and is not troubleshooting content. Surfacing it there could confuse users who are actively looking for help with missing data or incorrect behaviour.
Concrete proof: Navigate to /docs/observability/get-started, scroll to "Not seeing what you expected?". After this PR, that section will list the new article alongside "I have setup Langfuse but do not see traces" — an obvious editorial mismatch in intent and audience.
Refutation of the 404 concern: Several verifiers flagged that /faq/tag/agent-skill would 404 because no content/faq/tag/agent-skill.mdx file exists. This is not correct. app/[section]/[[...slug]]/page.tsx lines 43-58 implement a special case: when no MDX page is found for a /faq/tag/[tag] URL, it renders a dynamic FaqPreview filtered to that tag. Furthermore, generateStaticParams() (lines 222-233) iterates all FAQ pages, collects every tag found in frontmatter, and adds static params for any tag that lacks a dedicated content file. So /faq/tag/agent-skill will be statically generated and will render correctly — no 404 will occur. The "View all" link in FaqIndex is safe.
Why the content issue is real despite intentionality: One refuter argued the tags were deliberately chosen. That may be so, but deliberate tag selection that places an educational article inside a troubleshooting section is still an editorial mistake. Intention does not equal correct placement. The observability and prompt-management get-started troubleshooting sections serve a specific audience (users who have set up the integration but are not seeing data), and inserting a "how does agentic onboarding work" article there does not serve that audience.
Fix: Remove observability-get-started and prompt-management-get-started from the new file's tags list, leaving only agent-skill. If broader visibility of the agentic onboarding flow is desired across those pages, consider a dedicated informational section rather than piggybacking on the troubleshooting FAQ component.
FAQ section on what happens when people use a coding agent + skill to auto apply tracing or prompt management to their codebase
Link from main onboarding docs page to info what happens
