Symbol documentation
Platform spec feature
Symbol documentation
Spec standingStandard
No architecture decision records under adr/ for this feature yet. Standard features must
publish at least one ADR or keep a ## Decisions summary on the hub.
0 revisions (git unavailable at build; counts may be empty)
No commits recorded for this path.
Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).
What this feature specifies
The extension and LSP must resolve a documentation URL for a symbol at a cursor position and open it in the system browser. Registry packages link to pckg docs; unknown symbols fall back to the Beskid book.
LSP executeCommand
| Command | Arguments | Response |
|---|---|---|
beskid.symbol.getDocumentationUri | { uri: string, offset: number } | { url?: string } |
Resolution rules:
- When the symbol belongs to a locked registry dependency,
{registryBase}/docs/{package}@{version}(fragment optional for symbol anchor). - Otherwise
{bookBase}/book/search or qualified-name path when mapped. - Empty response when no documentation target exists.
Hover should append [View documentation](url) when url is present (modifier-click opens in browser).
Extension commands
| Command | Rule |
|---|---|
beskid.openSymbolDocumentation | Uses active editor URI + selection offset; calls LSP command; vscode.env.openExternal when URL returned |
Editor context menu should expose this command for beskid and beskid-proj resources.
Decisions
Section titled “Decisions”No open decisions.