Skip to content

Sync from fork: host Brownfield Experiment & Fair Comparison reports on-site#464

Merged
rdmueller merged 4 commits into
LLM-Coding:mainfrom
raifdmueller:main
May 8, 2026
Merged

Sync from fork: host Brownfield Experiment & Fair Comparison reports on-site#464
rdmueller merged 4 commits into
LLM-Coding:mainfrom
raifdmueller:main

Conversation

@raifdmueller
Copy link
Copy Markdown
Contributor

@raifdmueller raifdmueller commented May 8, 2026

Summary

Brings fork PR #27 to upstream.

The Brownfield Workflow page used to link the two experiment reports out to a personalAssistant repo. Both are now hosted on the site itself with their own routes:

  • /brownfield-experiment-report — Experiment 1a methodology and findings (subject project: Bausteinsicht), arc42 chapter-by-chapter assessment, Brownfield Preparation Checklist, prompt v2.
  • /brownfield-fair-comparison — Direct vs. Socratic vs. Two-Phase reverse-engineering with identical team answers; measures the structural value of the Question Tree.

Both routes are wired up end-to-end (page handlers, fallback content loader, route titles, render-docs.js AsciiDoc-to-HTML, prerender-routes.js SEO prerender — 13 routes total, was 11). The brownfield-workflow page now links to them locally.

Reference

Fork PR: raifdmueller#27

Summary by CodeRabbit

Dokumentation

  • Zwei neue Berichte zur Brownfield-Experiment-Dokumentation hinzugefügt: Ein detaillierter Experiment-Bericht mit Methodik, Ergebnissen und Verbesserungen sowie ein Vergleichsbericht zu verschiedenen Dokumentationsgenerierungsansätzen.
  • Neue Dokumentationsseiten sind jetzt auf der Website verfügbar und in die Navigation integriert.

Chores

  • Website-Build-Prozesse aktualisiert, um die neuen Dokumentationen zu berücksichtigen.

raifdmueller and others added 4 commits May 8, 2026 18:46
Previously linked externally to a personalAssistant repo. The report
documents a controlled experiment: delete documentation from a
greenfield project (Bausteinsicht), regenerate from code via the
Semantic-Anchor-driven prompt, and compare. Findings include the
Brownfield Preparation Checklist (six items code cannot reveal) and
v2 of the prompt with role assignments on Open Questions.

Wires it up as a first-class route /brownfield-experiment-report so
brownfield-workflow.adoc can link to it locally instead of the
external repo. The Fair Comparison link is left unchanged for now —
not yet hosted.
The brownfield-workflow page references a second report — the Fair
Comparison of Direct vs. Socratic vs. Two-Phase reverse-engineering
approaches with identical team answers. Like the Experiment 1a
report, host it locally instead of pointing at the personalAssistant
repo.

- New file docs/brownfield-fair-comparison.adoc
- New route /brownfield-fair-comparison wired the same way as the
  Experiment 1a report (router title, page handler, fallback handler,
  render-docs entry, prerender-routes entry — 13 routes pre-rendered)
- brownfield-workflow.adoc now links to the internal route
…eport

feat: host Brownfield Experiment 1a Report on the site
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack
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: 96a329f4-961f-4ed4-b61d-0c8c11d41a33

📥 Commits

Reviewing files that changed from the base of the PR and between 4cd2da3 and a1ce7f6.

📒 Files selected for processing (7)
  • docs/brownfield-experiment-report.adoc
  • docs/brownfield-fair-comparison.adoc
  • docs/brownfield-workflow.adoc
  • scripts/prerender-routes.js
  • scripts/render-docs.js
  • website/src/main.js
  • website/src/utils/router.js

Walkthrough

Der PR fügt zwei neue AsciiDoc-Dokumentationsberichte zur Brownfield-Dokumentationswiederherstellung hinzu und integriert sie in die Website. Die Dokumentations-Rendering-Pipeline, Prerendering-Konfiguration und SPA-Routing werden aktualisiert, um die neuen Routen zu unterstützen. Eine bestehende Workflow-Dokumentation wird mit internen Ankern aktualisiert.

Changes

Brownfield-Dokumentation und Routing-Integration

Layer / File(s) Summary
Report Documentation Content
docs/brownfield-experiment-report.adoc, docs/brownfield-fair-comparison.adoc, docs/brownfield-workflow.adoc
Neue Experiment-Evaluierungsberichte dokumentieren ein Brownfield-Experiment (Prompt v1/v2, Ergebnisse, Verbesserungen) und einen Vergleich von drei Dokumentationsgenerierungs-Ansätzen. Brownfield-Workflow-Referenzen werden von externen GitHub-URLs zu internen AsciiDoc-Ankern aktualisiert.
Documentation Rendering Pipeline
scripts/render-docs.js, scripts/prerender-routes.js
render-docs.js rendert die zwei neuen AsciiDoc-Dateien zu HTML. prerender-routes.js wird mit zwei neuen Routen-Deskriptoren für /brownfield-experiment-report und /brownfield-fair-comparison mit SEO-Titeln und Meta-Beschreibungen erweitert.
SPA Route Registration and Navigation
website/src/main.js, website/src/utils/router.js
Zwei neue Routen werden mit entsprechenden Seiten-Renderer-Funktionen registriert, die .adoc-Inhalte laden. ROUTE_TITLES wird mit neuen Titel-Mappings erweitert. Der handleLanguageChange-Handler wird aktualisiert, um Doc-Inhalte für die neuen Routen neu zu laden.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 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 beschreibt klar und präzise die Hauptänderung: das Hosten von zwei Brownfield-Experiment-Berichten auf der Website. Er ist konkret, aussagekräftig und bezieht sich direkt auf die Kernänderung des Changesets.
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 2acdc80 into LLM-Coding:main May 8, 2026
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