docs: comprehensive SDK API reference #394

New Issue

forbes · 2026-03-03T23:04:43Z

forbes commented

2026-03-03 23:04:43 +00:00

Summary

Write a complete SDK API reference covering every public function in kindred_sdk, organized by module.

Current state (PARTIAL)

docs/src/reference/kcsdk-python.md covers EditingContext and PanelProvider APIs (~200 lines). No docs for:

Event bus (emit, on, off)
Lifecycle callbacks (on_context_enter, on_context_exit)
Addon registry queries (is_addon_loaded, addon_version, loaded_addons)
Per-document origin (document_origin, set_document_origin)
Asset path resolution (addon_resource)
Load diagnostics (addon_diagnostics)
Context introspection (available_contexts, context_history)
Transition guards (add_transition_guard)
Breadcrumb injection (inject_breadcrumb)

Scope

Create or extend docs/src/reference/sdk-api.md
Organized by module: context, origin, events, registry, assets, dock, command, toolbar, menu, theme, statusbar
Each function: signature, parameter descriptions, return type, example usage
Update docs/src/SUMMARY.md with link

Dependencies

Should be updated as each feature issue (#381-#393) is implemented. Initial version covers existing APIs; expanded as new APIs land.

Roadmap

v0.2.0 — Testing and Documentation

## Summary Write a complete SDK API reference covering every public function in `kindred_sdk`, organized by module. ## Current state (PARTIAL) `docs/src/reference/kcsdk-python.md` covers EditingContext and PanelProvider APIs (~200 lines). No docs for: - Event bus (emit, on, off) - Lifecycle callbacks (on_context_enter, on_context_exit) - Addon registry queries (is_addon_loaded, addon_version, loaded_addons) - Per-document origin (document_origin, set_document_origin) - Asset path resolution (addon_resource) - Load diagnostics (addon_diagnostics) - Context introspection (available_contexts, context_history) - Transition guards (add_transition_guard) - Breadcrumb injection (inject_breadcrumb) ## Scope - Create or extend `docs/src/reference/sdk-api.md` - Organized by module: context, origin, events, registry, assets, dock, command, toolbar, menu, theme, statusbar - Each function: signature, parameter descriptions, return type, example usage - Update `docs/src/SUMMARY.md` with link ## Dependencies Should be updated as each feature issue (#381-#393) is implemented. Initial version covers existing APIs; expanded as new APIs land. ## Roadmap v0.2.0 — Testing and Documentation

forbes added the documentation label 2026-03-03 23:04:43 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: kindred/create#394