Skip to content

refactor: move agent installation docs to separate file#407

Merged
rdmueller merged 1 commit intoLLM-Coding:mainfrom
raifdmueller:refactor/move-agent-installation-docs
Apr 6, 2026
Merged

refactor: move agent installation docs to separate file#407
rdmueller merged 1 commit intoLLM-Coding:mainfrom
raifdmueller:refactor/move-agent-installation-docs

Conversation

@raifdmueller
Copy link
Copy Markdown
Contributor

@raifdmueller raifdmueller commented Apr 6, 2026

Summary

The detailed agent installation instructions (6 agents, installer commands, hook setup) were prominently placed in both READMEs. These are primarily useful for local or smaller LLMs that don't have semantic anchors in their training data — frontier models already recognize anchors without explicit definitions.

  • Moved full installation guide to docs/agent-installation.adoc
  • Added context explaining when you need this (local LLMs)
  • Replaced README sections with a short paragraph + link

Test plan

  • README.adoc and README.md show the short "Local LLMs" paragraph
  • Link to docs/agent-installation.adoc works
  • Full installation guide preserved in the new file

🤖 Generated with Claude Code

Summary by CodeRabbit

Dokumentation

  • Dokumentation
    • Vereinfachte Installationsanleitung für lokale Large Language Models
    • Neue dedizierte Anleitung für die Integration mit verschiedenen Coding Agents verfügbar
    • Klarere Dokumentation zur Kompatibilität mit Frontier LLMs und kleineren Modellen

The detailed agent installation instructions (6 agents, installer
commands, hook setup) are primarily useful for local/smaller LLMs
that don't have semantic anchors in their training data. Frontier
models already recognize anchors without explicit definitions.

Moved the full guide to docs/agent-installation.adoc and replaced
the README sections with a short paragraph linking to it.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 6, 2026

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: 88177cec-7076-4bd2-b5ce-49bd64be9842

📥 Commits

Reviewing files that changed from the base of the PR and between 9ce2102 and a2120a6.

📒 Files selected for processing (3)
  • README.adoc
  • README.md
  • docs/agent-installation.adoc

Walkthrough

Die Pull-Request reorganisiert die Dokumentation zur Installation von semantischen Ankern für Coding-Agents. Die Installations-Anleitung wird aus den README-Dateien entfernt und in eine neue, dedizierte Dokumentationsdatei (docs/agent-installation.adoc) ausgelagert. Die README-Dateien werden gekürzt und verweisen auf die neue Anleitung.

Changes

Cohort / File(s) Zusammenfassung
README-Dateien
README.adoc, README.md
Abschnitt "Installation for Coding Agents" in "Using Anchors with Local LLMs" umbenannt und detaillierte Installationsschritte (Portable Installer, Agent-spezifische Konfiguration) entfernt. Ersetzt durch Verweis auf neue Agent Installation Guide und Hinweis, dass frontier LLMs Semantic Anchors bereits erkennen können.
Neue Dokumentation
docs/agent-installation.adoc
Neue Dokumentationsdatei mit umfassender Anleitung zur Installation von Semantic Anchors. Enthält "Portable Baseline (Recommended)"-Workflow, Agent-spezifische Setups (Codex, Claude Code, Gemini CLI, Cursor, GitHub Copilot, Windsurf) und Installationsskript-Parameter.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 Minuten

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Pull-Request-Titel beschreibt präzise die Hauptänderung: Die Verlagerung der Agent-Installationsdokumentation in eine separate Datei, was exakt der Kernänderung des Changesets entspricht.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 75092d9 into LLM-Coding:main Apr 6, 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