Skip to content

fix: render the German Contributing page from the maintained source - #697

Merged
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:fix/de-contributing-orphaned-source
Jul 24, 2026
Merged

fix: render the German Contributing page from the maintained source#697
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:fix/de-contributing-orphaned-source

Conversation

@raifdmueller

@raifdmueller raifdmueller commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Problem

The German Contributing page at /de/contributing is rendered from website/public/CONTRIBUTING.de.adoc. That file has not been touched since #603. Every contributor edit since then went into docs/CONTRIBUTING.de.adoc — the file that sits next to its English sibling and looks like the maintained one. Nothing rendered it.

Verified on the live site — https://llm-coding.github.io/Semantic-Anchors/de/contributing is missing:

German contributors have been reading the state of #603 for months.

Fix

  • scripts/render-docs.js renders docs/CONTRIBUTING.de.adoc instead of the copy under website/public/
  • the stale website/public/CONTRIBUTING.de.adoc is deleted — one German source again
  • five relative link: targets in both Contributing files (ADR-007, ADR-008, docs/roles/) resolved against the served route and 404'd on the website; they now use absolute GitHub URLs, which work on the site and in GitHub's rendered view
  • .gitignore covers the generated CONTRIBUTING*.toc.html build artifacts, which were showing up as untracked

The client only ever fetches the rendered .html (doc-page.js:43), never the .adoc, so removing the public source is safe. The output path website/public/CONTRIBUTING.de.html is unchanged.

Verification

npm run build✓ pre-rendered /contributing (+ /de variant). The prerendered dist/de/contributing/index.html now carries all sections, and both ADR links resolve:

Was sind Semantic Anchors? / Artefakttypen: Anchor, Contract, Skill /
Qualitätskriterien / Testen Ihres semantischen Ankers /
Viability-Test (Liefert der Anker?) / … / Entwicklungsumgebung /
Criticism und Current Status / PR-Review-Richtlinie / Issue-Titel-Konvention / …

npm run lint clean, npm test 121/121 passing.

Note for #641

@JensGrote#641 adds a German Viability-Test section to website/public/CONTRIBUTING.de.adoc, the file this PR deletes. docs/CONTRIBUTING.de.adoc already carries that section from #640, so once this merges that part of #641 is redundant. The rejected-proposals changes in #641 are unaffected. See my review there for the separate dead-link issue.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Fehlerbehebungen

    • Die deutsche Beitragsseite wird wieder aus der aktuellen Dokumentationsquelle erstellt.
    • Deutsche Änderungen an den Beitragsrichtlinien sind nun auf der Website sichtbar.
    • Fehlerhafte Dokumentationslinks wurden korrigiert, sodass sie in Website und Repository zuverlässig funktionieren.
  • Dokumentation

    • Verweise auf Begründungen, Rollenbeschreibungen und weitere Ressourcen wurden aktualisiert.
    • Ein neuer Changelog-Eintrag dokumentiert die Korrekturen.
  • Wartung

    • Generierte Inhaltsverzeichnisse werden nicht mehr versehentlich versioniert.
    • Eine veraltete, doppelte Quelldatei für die deutsche Beitragsseite wurde entfernt.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@raifdmueller, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 23 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b5f7426-3174-4450-a134-9be14045bbfe

📥 Commits

Reviewing files that changed from the base of the PR and between 9ae136a and 4aa06f3.

📒 Files selected for processing (6)
  • .gitignore
  • CONTRIBUTING.adoc
  • docs/CONTRIBUTING.de.adoc
  • docs/changelog.adoc
  • scripts/render-docs.js
  • website/public/CONTRIBUTING.de.adoc

Walkthrough

Die deutsche CONTRIBUTING-Dokumentation wird künftig aus docs/CONTRIBUTING.de.adoc gerendert. Eine verwaiste öffentliche Kopie wird entfernt, mehrere Dokumentationslinks werden auf absolute GitHub-URLs aktualisiert und generierte TOC-Dateien werden ignoriert.

Changes

CONTRIBUTING-Dokumentation

Layer / File(s) Summary
Deutsche CONTRIBUTING-Quelle korrigieren
scripts/render-docs.js, website/public/CONTRIBUTING.de.adoc
Das Rendering verwendet docs/CONTRIBUTING.de.adoc als Quelle; die verwaiste Datei unter website/public/ wird entfernt.
Dokumentationslinks und Veröffentlichungsartefakte aktualisieren
CONTRIBUTING.adoc, docs/CONTRIBUTING.de.adoc, docs/changelog.adoc, .gitignore
ADR- und Rollenlinks werden auf absolute GitHub-URLs umgestellt, der Changelog beschreibt die Korrektur und generierte CONTRIBUTING-TOCs werden ignoriert. Der topic-neutrale Gate-Text bleibt inhaltlich unverändert.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Titel beschreibt präzise die Hauptänderung: die deutsche Contributing-Seite wird nun aus der gepflegten Quelle gerendert.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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.

@raifdmueller

Copy link
Copy Markdown
Contributor Author

The failing Dependency Security Audit here is not caused by this PR — it touches only .adoc files, .gitignore and render-docs.js, no dependencies.

New advisories were published against dependency versions that have not changed. Running the same command on a clean checkout of main produces the identical result:

6 vulnerabilities (1 low, 3 moderate, 2 high)

Main's last green run is 6 days old, which is why nobody has seen it yet. Every PR opened from now on hits it.

#698 fixes it — npm audit fix without --force, package-lock.json only. All checks green there, including the audit. Once #698 is merged I will rebase this PR so its audit job re-runs.

The /de/contributing page was built from website/public/CONTRIBUTING.de.adoc,
while every contributor edit since LLM-Coding#603 went into docs/CONTRIBUTING.de.adoc —
the file next to its English sibling. Nothing rendered that file, so German
readers never saw the artifact taxonomy (LLM-Coding#585), the Viability Test (LLM-Coding#640), the
ADR-008 topic-neutral gate, the issue-title convention (LLM-Coding#564), or the developer
setup, PR review policy and Criticism/Current-Status rules from LLM-Coding#695.

- render-docs.js renders docs/CONTRIBUTING.de.adoc; the stale public/ copy is
  deleted, leaving one German source
- rewrite five relative link: targets in both Contributing files (ADR-007,
  ADR-008, docs/roles/) that resolved against the served route and 404'd
- gitignore the generated CONTRIBUTING*.toc.html build artifacts

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@raifdmueller
raifdmueller force-pushed the fix/de-contributing-orphaned-source branch from 9ae136a to 4aa06f3 Compare July 24, 2026 19:08
@rdmueller
rdmueller merged commit 7f40569 into LLM-Coding:main Jul 24, 2026
8 checks passed
@raifdmueller
raifdmueller deleted the fix/de-contributing-orphaned-source branch July 24, 2026 19:19
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