Skip to content
This repository was archived by the owner on Jun 9, 2026. It is now read-only.

feat(wp-n4): LSP + Fork Documentation - #53

Merged
Steffen025 merged 3 commits into
devfrom
feature/wp-n4-lsp-fork
Mar 11, 2026
Merged

feat(wp-n4): LSP + Fork Documentation#53
Steffen025 merged 3 commits into
devfrom
feature/wp-n4-lsp-fork

Conversation

@Steffen025

@Steffen025 Steffen025 commented Mar 11, 2026

Copy link
Copy Markdown
Owner

WP-N4: LSP + Fork Documentation

Documentation-only work package. No plugin code changes.

Changes

AGENTS.md — 2 new sections added after ## OpenCode Session API

## Code Navigation (LSP Integration)

  • Documents OpenCode's 35+ built-in LSP servers
  • Available tools: goToDefinition, findReferences, hover, callHierarchy
  • LSP vs. Grep comparison table with concrete use-case guidance
  • Activation: OPENCODE_EXPERIMENTAL_LSP_TOOL=true

## Safe Experiments (Session Fork)

  • Documents Session Fork as the OpenCode-native Plan Mode equivalent
  • POST /session/{sessionID}/fork API reference
  • Fork workflow integrated into PAI Algorithm (PLAN → BUILD checkpoint)
  • Use-cases: risky refactoring, multi-approach exploration, destructive ops

PAI-Install/engine/steps-fresh.ts

  • Adds commented OPENCODE_EXPERIMENTAL_LSP_TOOL=true to installer-generated .env
  • Discoverable but opt-in (commented out by default)

docs/epic/TODO-v3.0.md

ADR References

  • ADR-014: LSP Native Code Navigation
  • ADR-016: Session Fork Experiment Isolation

Checklist

  • Documentation only — no plugin code changes
  • Branch targets dev (not main)
  • Conventional commit format
  • No secrets introduced

Summary by CodeRabbit

  • Dokumentation

    • Neue Abschnitte: Code-Navigation (LSP-Integration) und Sichere Experimente (Session Fork) in AGENTS.md
    • Installationshinweis erweitert: kommentierter, optionaler Hinweis zu einem experimentellen LSP-Tool in der Installer-Umgebung
  • Projektstatus

    • WP-N1 bis WP-N4 als abgeschlossen markiert; WP-N5 als nächster Punkt vermerkt und Überschriften/Statuszeilen entsprechend aktualisiert

Add two new AGENTS.md sections documenting OpenCode-native features:

## Code Navigation (LSP Integration)
- Documents 35+ built-in LSP servers (goToDefinition, findReferences, hover, callHierarchy)
- LSP vs. Grep comparison table with clear use-case guidance
- Activation via OPENCODE_EXPERIMENTAL_LSP_TOOL=true

## Safe Experiments (Session Fork)
- Documents Session Fork as Plan Mode native equivalent
- POST /session/{id}/fork API reference with messageID usage
- Fork workflow for Algorithm PLAN → BUILD phase checkpoints
- Use-cases: risky refactoring, multi-approach exploration, destructive operations

## Installer update
- PAI-Install/engine/steps-fresh.ts: Adds commented LSP env var to generated .env

## TODO update
- WP-N3: 90% → 100% complete (PR #52+#53)
- WP-N4: 0% → 100% complete (PR #54)
@coderabbitai

coderabbitai Bot commented Mar 11, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 01070c2b-8368-4691-a768-a262782546a3

📥 Commits

Reviewing files that changed from the base of the PR and between 370598f and 5086ad5.

📒 Files selected for processing (1)
  • docs/epic/TODO-v3.0.md

📝 Walkthrough

Walkthrough

Der PR ergänzt Dokumentation: LSP-Integration und Session-Fork (Safe Experiments) in AGENTS.md, fügt kommentierte Hinweise zum experimentellen LSP-Flag in PAI-Install/engine/steps-fresh.ts hinzu und aktualisiert Status/Checklisten in docs/epic/TODO-v3.0.md. Keine funktionalen Code-Änderungen.

Changes

Cohort / File(s) Summary
Dokumentation — AGENTS
AGENTS.md
Zwei neue Abschnitte hinzugefügt: „Code Navigation (LSP Integration)“ und „Safe Experiments (Session Fork)“ mit Nutzungshinweisen, Workflows und API-Referenzen.
Installer / Env-Hinweise
PAI-Install/engine/steps-fresh.ts
Kommentierter Block in der .env-Erzeugung ergänzt, der das experimentelle OPENCODE_EXPERIMENTAL_LSP_TOOL-Flag und zugehörige Hinweise dokumentiert (nur Kommentare).
Roadmap / Epic
docs/epic/TODO-v3.0.md
Status- und Checklist-Updates: WP-N1..N4-/WP-N3/WP-N4-Einträge als abgeschlossen markiert; Statuszeilen und Zeitstempel angepasst.
Metadaten / Manifest
package.json
Leichte Aktualisierungen im Manifest (Zeilenänderungen reflektiert), keine API-/Export-Deklarationsänderungen.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Poem

🐰 Hüpf, die Seiten wachsen sacht,
LSP-Leitpfade blinken in der Nacht,
Forks als Prüfpunkte, sicher, fein,
Roadmap-Häkchen — fertig, rein!
Ein Häschen feiert leise mit ’nem Reim.

🚥 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 Titel bezieht sich direkt auf die Hauptänderungen des Pull Requests: LSP-Integration und Session Fork-Dokumentation werden in AGENTS.md hinzugefügt, und die Dokumentation ist klar und prägnant formuliert.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/wp-n4-lsp-fork

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
AGENTS.md (1)

347-347: Bitte Obsidian-Callout-Syntax verwenden.

Die beiden Hinweise sollten als Callouts mit > [!NOTE] statt > **Note:** formatiert werden, damit das Dokument konsistent bleibt.

As per coding guidelines "Markdown files — Obsidian-formatted documentation. Verify: Callouts use > [!type] syntax".

Also applies to: 353-353

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 347, Replace the plain Markdown note lines that use `>
**Note:**` with Obsidian callout syntax `> [!NOTE]` so they follow the
repository's "Obsidian-formatted documentation" guideline; specifically update
the line containing `> **Note:** LSP tools are only available when
\`OPENCODE_EXPERIMENTAL_LSP_TOOL=true\` is set. Without this flag, the tools are
not registered and will not appear in the tool list.` and the similar occurrence
referenced (around the second instance), ensuring both use `> [!NOTE]` and the
original message text remains unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Around line 384-391: The code block showing the PLAN phase steps does not have
a language identifier, which triggers the MD040 Markdownlint warning. To fix
this, add a language tag such as `text` right after the opening triple backticks
in the code block surrounding the steps. This will correctly mark the content as
plain text and resolve the linting warning in the AGENTS.md file.

In `@docs/epic/TODO-v3.0.md`:
- Line 33: Die Einträge sind inkonsistent: ändere die PR-Referenz von "PR `#54`"
zu "PR `#53`" dort wo "WP-N4" erwähnt wird (und gleiche dieselbe Änderung an den
weiteren betroffenen Stellen, z. B. den Einträgen bei den Markierungen um Zeile
407 und 415), und passe die Formulierung zum LSP-Toggle so an, dass statt "Set
... =true" klarsteht, dass der Installer den Eintrag kommentiert/als Opt‑in
erzeugt (z. B. "Der Installer legt einen auskommentierten Eintrag an; Anwender
müssen ihn aktivieren, um LSP zu aktivieren").

---

Nitpick comments:
In `@AGENTS.md`:
- Line 347: Replace the plain Markdown note lines that use `> **Note:**` with
Obsidian callout syntax `> [!NOTE]` so they follow the repository's
"Obsidian-formatted documentation" guideline; specifically update the line
containing `> **Note:** LSP tools are only available when
\`OPENCODE_EXPERIMENTAL_LSP_TOOL=true\` is set. Without this flag, the tools are
not registered and will not appear in the tool list.` and the similar occurrence
referenced (around the second instance), ensuring both use `> [!NOTE]` and the
original message text remains unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: baae88b8-978b-4d1c-b2b5-e857733a131d

📥 Commits

Reviewing files that changed from the base of the PR and between 4f63037 and dc39660.

📒 Files selected for processing (3)
  • AGENTS.md
  • PAI-Install/engine/steps-fresh.ts
  • docs/epic/TODO-v3.0.md

Comment thread AGENTS.md Outdated
Comment thread docs/epic/TODO-v3.0.md Outdated
- AGENTS.md: Add 'text' language tag to Fork Workflow code block (MD040)
- AGENTS.md: Convert '> **Note:**' to '> [!NOTE]' callout syntax (L347, L354)
- TODO-v3.0.md: Correct PR reference #54#53 (L33, L407)
- TODO-v3.0.md: Clarify LSP installer entry is commented/opt-in by default

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/epic/TODO-v3.0.md`:
- Around line 32-33: Die Fortschrittsmatrix markiert WP-N3 und WP-N4 als
abgeschlossen, aber die Detailabschnitte und der „Updated“-Footer sind noch
veraltet; passe alle Stellen in der Datei an, so dass WP-N3 und WP-N4 in den
Detailabschnitten (wo „⏳ Implemented“ bzw. „awaiting PR review/merge“ steht) auf
den gleichen Abschlusstatus gesetzt werden wie in der Matrix, aktualisiere den
„Updated“-Footer-Datums-/Versionshinweis sowie alle referenzierten PR-Nummern
(z. B. PR `#52`, PR `#53`) und suche nach weitere Erwähnungen von WP-N3/WP-N4, um
Konsistenz über die ganze Datei sicherzustellen.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 39976448-041d-4002-be9c-748b3b0b3aa8

📥 Commits

Reviewing files that changed from the base of the PR and between dc39660 and 370598f.

📒 Files selected for processing (2)
  • AGENTS.md
  • docs/epic/TODO-v3.0.md
✅ Files skipped from review due to trivial changes (1)
  • AGENTS.md

Comment thread docs/epic/TODO-v3.0.md
- Header Updated line: reflect WP-N1..N4 all complete (PR #50-#53)
- WP-N2 detail section: 'awaiting PR review/merge' → 'Merged into dev'
- WP-N3 heading: '⏳ Implemented (PR #52)' → '✅ Complete (PR #52+#53)'
- WP-N3 detail section: 'awaiting PR review/merge' → 'Merged into dev'
- Footer: update to reflect N1-N4 complete, WP-N5 next
@Steffen025
Steffen025 merged commit 5275f37 into dev Mar 11, 2026
2 checks passed
@Steffen025
Steffen025 deleted the feature/wp-n4-lsp-fork branch March 11, 2026 22:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant