docs(academy): shorten intro on academy landing page#2956
docs(academy): shorten intro on academy landing page#2956Lotte-Verheyden wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@claude review |
|
|
||
| The goal is to explain why each step exists, what problem it solves, and how the steps connect. | ||
| The structure of the academy follows the AI engineering lifecycle, which is a continuous loop. It explains why each step exists, why, and how the steps connect. For each step, you can choose how deep you go. | ||
|
|
There was a problem hiding this comment.
🔴 The condensed intro on line 12 reads "It explains why each step exists, why, and how the steps connect." — the middle clause is an orphan "why" left over from the original sentence ("...what problem it solves..."), making it ungrammatical. Either drop the middle clause ("It explains why each step exists and how the steps connect.") or restore the intended phrase ("what problem it solves"). User-visible copy error on a public Academy landing page introduced directly by this PR.
Extended reasoning...
What is wrong
Line 12 of content/academy/index.mdx now reads:
It explains why each step exists, why, and how the steps connect.
The middle clause is just the bare word "why" with no predicate, making the sentence ungrammatical. It reads as an obvious typo.
How it got introduced
The pre-PR version of this paragraph said:
The goal is to explain why each step exists, what problem it solves, and how the steps connect.
When the paragraph was condensed in this PR, the second item ("what problem it solves") was clearly intended to be removed along with the surrounding rewrite, but only the verb phrase was deleted — the leading word that previously chained from "why each step exists" was left behind as a stranded "why". The result is a three-item list whose middle item collapsed to a single interrogative.
Impact
This is on the public Langfuse Academy landing page (/academy), which the PR description explicitly frames as polish/copy work. A grammatical error in the very copy being polished is user-visible and undermines the intent of the change. It will be the first thing a reader sees under "What you will find here".
Step-by-step proof
- Open
content/academy/index.mdxafter the PR is applied. - Locate the section heading
## What you will find here(around line 10). - Read line 12:
The structure of the academy follows the AI engineering lifecycle, which is a continuous loop. It explains why each step exists, why, and how the steps connect. For each step, you can choose how deep you go. - Parse the second sentence: subject "It", verb "explains", object — a list of three items:
- "why each step exists" (clause)
- "why" (just an interrogative, no clause)
- "how the steps connect" (clause)
- The middle item is not parallel with the other two and has no predicate; the sentence is broken.
Suggested fix
Either drop the orphan clause:
-It explains why each step exists, why, and how the steps connect.
+It explains why each step exists and how the steps connect.…or restore the original middle item:
-It explains why each step exists, why, and how the steps connect.
+It explains why each step exists, what problem it solves, and how the steps connect.
Summary
Greptile Summary
This PR condenses the introductory copy on the Langfuse Academy landing page — merging a two-paragraph intro into one and tightening the "What you will find here" section above the loop diagram.
Confidence Score: 4/5
Safe to merge after fixing the duplicate 'why' in line 12; the rest of the copy changes are clean.
The condensed 'What you will find here' paragraph contains a duplicate word ('why … why') that appears to be a copy-editing artefact from the rewrite. Every other change in the file is well-formed prose.
content/academy/index.mdx — line 12 has the duplicate 'why' that needs a one-word fix before merging.
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[Welcome to Langfuse Academy] --> B[What you will find here] B --> C[The AI Engineering Loop] C --> D[Trace] C --> E[Monitor] C --> F[Build datasets] C --> G[Experiment] C --> H[Evaluate]Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs(academy): shorten intro on academy ..." | Re-trigger Greptile