Skip to content

fix(docs): address review on the Anchors and Training Data article#589

Merged
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:fix/article-review-followups
Jun 9, 2026
Merged

fix(docs): address review on the Anchors and Training Data article#589
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:fix/article-review-followups

Conversation

@raifdmueller

@raifdmueller raifdmueller commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #586, addressing the CodeRabbit + Copilot review.

  • main.js (real bug, CodeRabbit): handleLanguageChange() had no case for /training-data-vs-practice, so toggling EN/DE on the article did not re-render it, unlike every other doc route. Added the branch (mirrors harness-inventory).
  • router.js (Copilot): aligned the browser/tab title with the article's actual title (An Anchor Delivers Only as Far as the Prior Reaches) instead of the nav label.
  • article (Copilot): dropped the "full fully-dressed" wording redundancy (2 spots).

Skipped the "&" → "and" nav-label nit — "&" is idiomatic and short in a nav menu.

The cross-model validation (GPT-5 / Gemini) from @JensGrote's review is intentionally not in this PR — he is opening a separate PR for that with his raw data.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Dokumentation
    • Sprachliche und stilistische Verbesserungen der Dokumentation zu semantischen Ankern.
    • Sprachunterstützung für die Ankerdokumentation optimiert.
    • Seitentitel aktualisiert für bessere Klarheit.

- main.js: reload the article on language switch (handleLanguageChange was
  missing a case for /training-data-vs-practice, unlike every other doc route)
- router.js: align the browser/tab title with the article's actual title
- article: drop the "full fully-dressed" redundancy

Addresses CodeRabbit + Copilot review feedback on LLM-Coding#586.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: e91d6346-1982-455b-930b-1146b9db08f3

📥 Commits

Reviewing files that changed from the base of the PR and between 5793584 and 7b45d16.

📒 Files selected for processing (3)
  • docs/training-data-vs-practice.adoc
  • website/src/main.js
  • website/src/utils/router.js

Walkthrough

Die PR ergänzt sprachliche Verbesserungen der Seite training-data-vs-practice.adoc und verdrahtet ihre Route mit neuem Titel in der Website-Infrastruktur. Die Dokumentation wird stilistisch überarbeitet, während main.js und router.js die Route und deren Anzeige registrieren.

Changes

Training-Data-vs-Practice Seite

Layer / Datei(en) Zusammenfassung
Dokumentinhalts-Überarbeitung
docs/training-data-vs-practice.adoc
Im einleitenden NOTE wird „full fully-dressed" zu „complete fully-dressed" korrigiert. Im Anchor-Diskussionsabschnitt werden attributionsbezogene Sätze sprachlich präzisiert und die Ceremony-Formulierung gestrafft, ohne Referenzen zu entfernen.
Route-Verdrahtung und Titeleintrag
website/src/main.js, website/src/utils/router.js
Die Route /training-data-vs-practice wird in handleLanguageChange() hinzugefügt, um Dokumentinhalte zu laden. Der Titelstring in ROUTE_TITLES wird von „Anchors and Training Data — Semantic Anchors" auf „An Anchor Delivers Only as Far as the Prior Reaches — Semantic Anchors" aktualisiert.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • LLM-Coding/Semantic-Anchors#586: Dieser PR passt die neu in #586 eingeführte Seite docs/training-data-vs-practice.adoc (Text/Korrektheit) sowie die zugehörige Route-/Titelverdrahtung in website/src/main.js und website/src/utils/router.js an.
  • LLM-Coding/Semantic-Anchors#113: Beide PRs erweitern website/src/main.js's Route-/Sprachwechsel-Handling, um zusätzliche AsciiDoc-Inhalte zu laden (dieser PR: /training-data-vs-practice, Referenced PR: /all-anchors).
  • LLM-Coding/Semantic-Anchors#533: Beide PRs erweitern in website/src/main.js die handleLanguageChange()-Logik sowie in website/src/utils/router.js die ROUTE_TITLES um zusätzliche Routen (dieser PR: /training-data-vs-practice, Referenced PR: /harness-inventory).

Suggested reviewers

  • JensGrote
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Titel bezieht sich direkt auf die Hauptänderung: Adressierung von Review-Feedback zum Anchors and Training Data Artikel.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rdmueller rdmueller merged commit 7ffe55a into LLM-Coding:main Jun 9, 2026
6 of 7 checks passed
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