Skip to content

docs(academy): shorten intro on academy landing page#2956

Open
Lotte-Verheyden wants to merge 1 commit into
mainfrom
shorten-academy-intro
Open

docs(academy): shorten intro on academy landing page#2956
Lotte-Verheyden wants to merge 1 commit into
mainfrom
shorten-academy-intro

Conversation

@Lotte-Verheyden
Copy link
Copy Markdown
Member

@Lotte-Verheyden Lotte-Verheyden commented May 16, 2026

Summary

  • Condense the two-paragraph intro under "Welcome to Langfuse Academy" into a single tighter paragraph.
  • Tighten the copy above the loop diagram under "What you will find here".

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.

  • The opening section under "Welcome to Langfuse Academy" is now a single paragraph that combines the probabilistic-output framing with the lifecycle explanation.
  • The "What you will find here" preamble is shortened and the link prompt changed from "start here, then go deeper" to offering an immediate dive into any step.

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]
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
content/academy/index.mdx:12
The word "why" appears twice in this sentence, which reads awkwardly and appears to be a copy-editing artefact from condensing the original "what problem it solves" clause. Removing the redundant "why" fixes the sentence.

```suggestion
The structure of the academy follows the AI engineering lifecycle, which is a continuous loop. It explains why each step exists and how the steps connect. For each step, you can choose how deep you go.
```

Reviews (1): Last reviewed commit: "docs(academy): shorten intro on academy ..." | Re-trigger Greptile

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label May 16, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 16, 2026

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

Project Deployment Actions Updated (UTC)
langfuse-docs Ready Ready Preview, Comment May 16, 2026 0:10am

Request Review

@dosubot dosubot Bot added the documentation Improvements or additions to documentation label May 16, 2026
@github-actions
Copy link
Copy Markdown

@claude review

Comment thread content/academy/index.mdx

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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔴 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

  1. Open content/academy/index.mdx after the PR is applied.
  2. Locate the section heading ## What you will find here (around line 10).
  3. 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.
  4. 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)
  5. 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.

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

Labels

documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant