feat(wp-n4): LSP + Fork Documentation - #53
Conversation
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)
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDer PR ergänzt Dokumentation: LSP-Integration und Session-Fork (Safe Experiments) in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (3)
AGENTS.mdPAI-Install/engine/steps-fresh.tsdocs/epic/TODO-v3.0.md
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
AGENTS.mddocs/epic/TODO-v3.0.md
✅ Files skipped from review due to trivial changes (1)
- AGENTS.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
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)goToDefinition,findReferences,hover,callHierarchyOPENCODE_EXPERIMENTAL_LSP_TOOL=true## Safe Experiments (Session Fork)POST /session/{sessionID}/forkAPI referencePAI-Install/engine/steps-fresh.ts
OPENCODE_EXPERIMENTAL_LSP_TOOL=trueto installer-generated.envdocs/epic/TODO-v3.0.md
ADR References
Checklist
dev(notmain)Summary by CodeRabbit
Dokumentation
Projektstatus