fix(seo): list brownfield reports and contracts in sitemap and llms.txt#483
Conversation
Brownfield reports, the Socratic Recovery Skill page, and the contracts page were pre-rendered but missing from sitemap.xml and llms.txt — so claude.ai and other fetchers could not discover them. Also adds a "Documentation" section at the top of llms.txt listing every top-level doc page with a one-sentence summary, following the llms.txt convention. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughDie PR erweitert das Semantic-Anchors-Katalog um Cockburn Use Cases und Socratic Code Theory Recovery-Methoden. Die neue Ankordefinition wird in AsciiDoc-Referenzen, generierte Dokumentations-Ausgaben (llms.txt) und Website-Sitemaps integriert. Zusätzlich werden neue statische Seiten-Routen für Brownfield-Reports und Contract-Dokumentation hinzugefügt. ChangesCockburn Use Cases & Semantic Contracts Katalog-Erweiterung mit Sitemap/Dokumentations-Integrationen
Geschätzte Code-Review-Aufwand🎯 2 (Simple) | ⏱️ ~10 Minuten Möglicherweise zugehörige PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
website/public/llms.txt (1)
12-43: ⚡ Quick winHTML-Facade in
llms.txtreduziert Maschinenlesbarkeit unnötig.Für ein LLM-orientiertes Textartefakt ist der eingebettete
<figure>/<button>/<svg>-Block sehr noisig. Bitte inllms.txtstattdessen auf eine kurze Textreferenz + Link reduzieren.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@website/public/llms.txt` around lines 12 - 43, Die HTML-figure/button/svg block in llms.txt (find the block starting with <figure class="youtube-facade-wrapper"> and containing <button>, <img>, <svg> and <figcaption>) is too noisy for an LLM-oriented text artifact; remove that full HTML facade and replace it with a concise plain-text reference containing the video title, the YouTube URL (https://youtu.be/Q_DWMayAQEQ) and the session summary link (https://rabauer.dev/en/blog/semantic-anchors/) on a single or two short lines so the file stays machine-readable and minimal.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@scripts/generate-llms-txt.js`:
- Around line 218-297: Prettier check is failing for this file; run the
formatter against the file and commit the changes. Specifically, format the code
that defines DOC_PAGES and the subsequent lines.push sequence (the block that
builds the "Documentation" section) by running the repository's Prettier config
(e.g., prettier --write <this file>), then verify ESLint/Prettier rules pass
locally (or fix any minor lint/format conflicts) and commit the formatted file
so the Prettier --check gate succeeds.
In `@website/public/llms.txt`:
- Around line 3459-3460: Die fette Überschrift enthält verschachtelte Sternchen
(`**What Cockburn does **not** prescribe**`) und rendert inkonsistent; ersetze
diese Zeichenfolge durch eine konsistente Hervorhebung wie `**What Cockburn does
not prescribe**` (suche nach der genauen Zeichenkette "What Cockburn does
**not** prescribe" im Diff) und überprüfe angrenzende Markdowns in derselben
Zeile/Paragraph (z. B. "**prose-based and notation-agnostic**") auf ähnliche
verschachtelte Asterisk-Fehler, damit die gesamte Zeile korrekt bolded bzw.
formatiert wird.
---
Nitpick comments:
In `@website/public/llms.txt`:
- Around line 12-43: Die HTML-figure/button/svg block in llms.txt (find the
block starting with <figure class="youtube-facade-wrapper"> and containing
<button>, <img>, <svg> and <figcaption>) is too noisy for an LLM-oriented text
artifact; remove that full HTML facade and replace it with a concise plain-text
reference containing the video title, the YouTube URL
(https://youtu.be/Q_DWMayAQEQ) and the session summary link
(https://rabauer.dev/en/blog/semantic-anchors/) on a single or two short lines
so the file stays machine-readable and minimal.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: e0b14c5b-e313-43e4-843c-dff4fe919f17
📒 Files selected for processing (5)
docs/all-anchors.adocscripts/generate-llms-txt.jsscripts/generate-sitemap.jswebsite/public/llms.txtwebsite/public/sitemap.xml
| **What Cockburn does **not** prescribe** | ||
| Cockburn's format is deliberately **prose-based and notation-agnostic**. It does not mandate Activity Diagrams, Gherkin, EARS, or any formal syntax. Those are complementary representations that can be layered on top — Activity Diagrams for visual flow, Gherkin for executable acceptance criteria, EARS for structured requirement statements. |
There was a problem hiding this comment.
Markdown-Formatierung in Line 3459 ist kaputt.
**What Cockburn does **not** prescribe** ist verschachtelt/falsch betont und rendert inkonsistent. Bitte auf konsistente Hervorhebung umstellen (z. B. **What Cockburn does not prescribe**).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/public/llms.txt` around lines 3459 - 3460, Die fette Überschrift
enthält verschachtelte Sternchen (`**What Cockburn does **not** prescribe**`)
und rendert inkonsistent; ersetze diese Zeichenfolge durch eine konsistente
Hervorhebung wie `**What Cockburn does not prescribe**` (suche nach der genauen
Zeichenkette "What Cockburn does **not** prescribe" im Diff) und überprüfe
angrenzende Markdowns in derselben Zeile/Paragraph (z. B. "**prose-based and
notation-agnostic**") auf ähnliche verschachtelte Asterisk-Fehler, damit die
gesamte Zeile korrekt bolded bzw. formatiert wird.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 participants
Summary
sitemap.xmlandllms.txt— so claude.ai and other fetchers had no way to discover them./brownfield-experiment-report,/brownfield-fair-comparison,/socratic-recovery-skill,/contractstoscripts/generate-sitemap.js(sitemap now lists 14 pages + 136 anchors).llms.txtlisting every top-level doc page with a one-sentence summary, following the llms.txt convention.Test plan
website/public/sitemap.xmlcontains the four new URLswebsite/public/llms.txtstarts with a "Documentation" section listing all doc pageshttps://llm-coding.github.io/Semantic-Anchors/sitemap.xmland…/llms.txt…/brownfield-experiment-report🤖 Generated with Claude Code
Summary by CodeRabbit
Neue Inhalte verfügbar
Dokumentation
Chores