Summary
Create an extensible framework for adding custom knowledge-source connectors to OpenWiki. Linear is one possible first connector, but the primary goal is to establish a reusable integration model for external systems.
Motivation
Important project context often lives outside OpenWiki in tools such as Linear, Jira, GitHub, and other planning or collaboration platforms. These systems contain work items, discussions, decisions, ownership, and history that could significantly improve answers generated by OpenWiki.
Without a standard connector mechanism, each integration would need to implement its own approach to authentication, data mapping, scoping, and synchronization.
Proposed Solution
Introduce a connector interface that allows integrations to define:
- Authentication and credential requirements
- Available workspaces, teams, projects, or other scopes
- Source entities and their relationships
- Mapping into OpenWiki’s knowledge and ingestion model
- Initial imports and incremental synchronization
- Handling of updates, deletions, and source links
- Filtering, redaction, and privacy controls
Linear could be used as an initial example. A Linear connector might import issues, sub-issues, comments, projects, cycles, initiatives, and documents while preserving their relationships and links to the original records.
The core ingestion and retrieval pipeline should remain provider-agnostic so that future connectors can be added independently.
Alternatives Considered
- Building a one-off Linear integration without a general connector abstraction. This would solve one immediate use case but make future integrations inconsistent and more expensive to maintain.
- Requiring users to export data manually. This would avoid API integrations but would not support incremental updates or reliable synchronization.
- Treating all providers as identical. This would simplify the interface but lose provider-specific capabilities, relationships, and permission models.
Additional Context
Linear is an example rather than the exclusive target. The same framework could eventually support systems such as Jira, ClickUp, GitHub, Notion, or internal company tools.
OAuth, API keys, and personal access tokens may be appropriate for different providers. Connector-specific scope selection would help users limit ingestion to relevant content and avoid importing an entire workspace unnecessarily.
Summary
Create an extensible framework for adding custom knowledge-source connectors to OpenWiki. Linear is one possible first connector, but the primary goal is to establish a reusable integration model for external systems.
Motivation
Important project context often lives outside OpenWiki in tools such as Linear, Jira, GitHub, and other planning or collaboration platforms. These systems contain work items, discussions, decisions, ownership, and history that could significantly improve answers generated by OpenWiki.
Without a standard connector mechanism, each integration would need to implement its own approach to authentication, data mapping, scoping, and synchronization.
Proposed Solution
Introduce a connector interface that allows integrations to define:
Linear could be used as an initial example. A Linear connector might import issues, sub-issues, comments, projects, cycles, initiatives, and documents while preserving their relationships and links to the original records.
The core ingestion and retrieval pipeline should remain provider-agnostic so that future connectors can be added independently.
Alternatives Considered
Additional Context
Linear is an example rather than the exclusive target. The same framework could eventually support systems such as Jira, ClickUp, GitHub, Notion, or internal company tools.
OAuth, API keys, and personal access tokens may be appropriate for different providers. Connector-specific scope selection would help users limit ingestion to relevant content and avoid importing an entire workspace unnecessarily.