Commit Graph
33 Commits
Author SHA1 Message Date
RockChinQandHyu 6d988f8f18 docs(plugin): document LLM request policy and SDK cancellation requirements (#142)
Co-authored-by: Hyu <[email protected]>
2026-10-15 20:07:47 +08:00
Hyu e279f2fae8 docs(plugin): document per-installation reuse and installation revocation
A Workspace installs a plugin once, but that single installation is reused by
several product objects: every processor for a Runner, every knowledge base for
a KnowledgeEngine / Parser / Retriever, and many conversations or page requests
for the other component kinds. The platform storage key carries no processor or
knowledge-base dimension, so a plugin must fold that identity into its own keys.

- certified-plugins: add "one installation, many usages" with the isolation
  dimensions per component kind, and "when an installation is revoked"
  documenting BasePlugin.on_installation_revoked, its trigger set, the absent
  invocation context and the no-op/failure semantics.
- component pages (runner, knowledge-engine, knowledge-retriever, parser, tool,
  command, event-listener, page): add a short component-specific section with
  that component's own rules and a link to the contract page.
- Align the background-work rule with the SDK contract: the SDK does not track
  ownership of detached work, so a plugin must keep its own binding-keyed
  registry and stop it in the revocation hook.

All three locales carry the same sections.
2026-09-29 20:10:56 +08:00
Hyu 85fb49c687 docs(plugin): refocus the certification page on developer decisions
Rewrite plugin/certified-plugins in all three locales around the
questions a plugin developer actually asks, and make it the single home
for certification: what it is, why it exists, when it is needed, what
changes after approval, and what the contract requires.

- Decision framing restored, including a needs/does-not-need table and
  the explicit statement that most plugins do not need certification.
- Full manifest example, accepted values for both declaration fields and
  the SDK version that recognises them.
- Constraints kept and tightened: stateless rules, allowed/forbidden
  table, anti-patterns with correct/incorrect snippets, Runner notes,
  self-check list.
- Submission flow moved onto this page so it no longer depends on the
  publishing page.
- Operator content that duplicates the Core architecture document
  removed (Cloud admission matrix, OSS issuer keys, certificate fields,
  internal review tiers).

publish/market is now publishing-only with a one-line pointer, and its
misplaced plugin_submission screenshot moves back under the upload
section where it belongs. dev/basic-info replaces the commented-out
manifest fields with a link to the contract page.

ja had been missing whole sections (36 lines); all three locales now
share the same section structure.
2026-09-29 14:40:58 +08:00
RockChinQ ee87bd0d7a docs(plugin): state certified artifacts must run shared 2026-09-28 18:44:16 +00:00
RockChinQandHermes Agent a87f896a91 docs(certification): align sharing eligibility and dedicated fallback (#138)
Co-authored-by: Hermes Agent <[email protected]>
2026-09-29 00:50:44 +08:00
RockChinQ f6b6a635c2 docs: stateless certified plugins
Comprehensive documentation for stateless singleton component model supporting SDK 0.7.0 and certificate v2 envelope.
2026-09-28 13:25:36 +08:00
RockChinQ 689da21f46 merge: integrate docs 4.11 into main 2026-09-24 02:39:29 +08:00
RockChinQ 124557f560 docs(plugin): document certified plugin releases (#134) 2026-09-20 18:31:22 +08:00
RockChinQ a5c1fb43e0 docs: explain runner sandbox APIs and custom select presets 2026-09-17 23:04:53 +08:00
RockChinQ 6dcbcf6eac docs(runner): explain processor configurations and bot subscriptions 2026-09-15 00:28:51 +08:00
RockChinQ 4b9ba0db6b docs(runner): require explicit usage declarations 2026-09-12 12:51:16 +08:00
RockChinQ df06842ecb docs(plugin): reorganize context API reference 2026-09-11 00:03:42 +08:00
RockChinQ 5cbe5eee59 docs(plugin): document unified Runner development and APIs 2026-09-10 18:04:42 +08:00
RockChinQ cb26081730 docs(plugin): document platform and run context APIs 2026-09-10 17:20:49 +08:00
RockChinQ 2a8bd3ceb2 docs(plugins): add EventProcessor component tutorial 2026-09-09 15:37:11 +08:00
dadachann a63d60a2a9 docs: update links to langbot.app/docs 2026-09-04 15:57:38 +00:00
Hyuanddadachann f9479575fa docs: explain optional runtime control and rotating debug keys (#110)
Co-authored-by: dadachann <[email protected]>
2026-08-04 19:07:10 +08:00
RockChinQ e75801e229 docs: rename 'LLMOps platform' to 'Agent platform' across wiki (zh/en/ja + nav) 2026-06-18 11:58:11 -04:00
RockChinQ 8326d3f313 docs(plugin): document auto-release workflow and zh README scaffold (SDK #68) 2026-06-09 07:39:20 -04:00
Junyan QinandClaude Opus 4.6 c3c22c3c00 docs: add Page component demo screenshot
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
2026-04-25 22:12:23 +08:00
Junyan QinandClaude Opus 4.6 7954aad0fe docs: add Japanese Page component tutorial
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
2026-04-25 22:02:52 +08:00
RockChinQ 47ae62c8bf docs: add tools API, tools-selector config type, and OpenAPI tools endpoints
- Plugin SDK APIs: list_tools, get_tool_detail, call_tool (zh/en/ja)
- Config type: tools-selector for multi-select tool picker (zh/en/ja)
- OpenAPI: GET /api/v1/tools, GET /api/v1/tools/{tool_name} (zh/en/ja)
2026-04-03 17:25:16 +08:00
Junyan Qin 6966b8a67d sync zh doc changes to en and ja: fix tag formats, add new languages, update MCP sources 2026-03-30 20:05:29 +08:00
Junyan Qin 202d200814 docs: enhance plugin configuration documentation with preset options for string and select types 2026-03-29 00:32:14 +08:00
RockChinQ e41ede941c docs: fix PAT login instructions and add Japanese translation
- zh/en: update path to '账户设置 → 账户 → 个人访问令牌'
- ja: add PAT login as recommended method with device code fallback
2026-03-25 21:57:44 +08:00
Junyan Qin 932dd36abf docs(plugin): restore list_pipeline_knowledge_bases in Request API section (zh/en/ja) 2026-03-23 21:23:53 +08:00
Junyan Qin 04d7bb1436 fix(plugin): use Mintlify Tip component instead of ::: syntax 2026-03-23 21:21:43 +08:00
Junyan Qin ff512163de docs(plugin): remove deprecated pipeline-scoped KB API docs (zh/en/ja)
Remove list_pipeline_knowledge_bases and retrieve_knowledge from Request API
section as they are fully superseded by the global Knowledge Base APIs.
2026-03-23 21:18:49 +08:00
Junyan Qin 7a5ed2482d docs(plugin): add Knowledge Base API documentation (zh/en/ja)
Document the new global list_knowledge_bases() and retrieve_knowledge()
APIs in the LangBot API section of plugin common APIs docs.
2026-03-23 21:10:13 +08:00
huanghuoguoguo 94337e6c8e feat: add list kbengine and parser api (#89) 2026-03-12 22:15:48 +08:00
632c23e841 Docs/rag engine plugin architecture (#82)
* docs: update wiki for RAG engine plugin architecture

Replace KnowledgeRetriever component docs with RAGEngine across all
three languages (zh/en/ja). Key changes:

- Add new rag-engine.mdx component docs covering RAGEngine base class,
  creation_schema/retrieval_schema, capability declarations, lifecycle
  hooks, host RAG APIs, and complete code examples
- Update knowledge base usage docs to reflect unified KB model (remove
  internal/external distinction, add RAG engine selection flow)
- Update component list (add.mdx) and plugin intro to reference RAGEngine
- Add RAG API section to plugin common APIs (invoke_embedding,
  vector_upsert/search/delete, get_rag_file_stream)
- Update docs.json navigation to point to rag-engine pages

Companion to LangBot PR #1995 and SDK PR #34.

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* fix: sync with sdk

* docs: update vector API docs with metadata filters, search_type, and documents support

- Replace Warning tags about unimplemented filters with Info tags documenting
  canonical filter format (Chroma-style where syntax) and supported operators
- Document search_type/query_text params for full-text and hybrid search
- Document documents param for vector_upsert
- Update RetrievalContext.filters description from reserved to active
- Add filter usage examples (en/zh/ja)

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* docs: enhance RAG Engine documentation across multiple languages

- Expanded the description of the RAG Engine component to include bridging capabilities with advanced knowledge base services like Dify, RAGFlow, and FastGPT.
- Clarified the `DOC_INGESTION` capability description, specifying conditions under which the declaration can be omitted.
- Updated documentation in English, Japanese, and Chinese to ensure consistency and clarity.

* docs: add instructions for show_if conditional rendering

* docs: add Parser component documentation (zh/en/ja)

Add Parser as a new component type in plugin docs. Parser extracts
structured text from binary files (PDF, Word, etc.) before RAG engine
ingestion. Includes manifest format, parse method API, data models
(ParseContext/ParseResult/TextSection), RAGEngine integration via
parsed_content, and cross-plugin invoke_parser API.

Also add DOC_PARSING capability to RAG engine docs and parsed_content
field to IngestionContext.

Companion to SDK PR langbot-app/langbot-plugin-sdk#37 and
LangBot PR langbot-app/LangBot#2000.

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* docs: rename RAGEngine components to KnowledgeEngine

* refactor: change rag engine to knowledge engine

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
Co-authored-by: Junyan Qin <[email protected]>
2026-03-09 00:58:41 +08:00
Junyan Qin 93a73a7c70 Add Satori platform support in documentation, including features and usage instructions for Lucky Lilla Desktop 2026-02-23 15:26:50 +08:00
Xiaoyu SuandJunyan Chin 310c566148 refactor: migration to mintlify
* 重构文档结构:移除 docs 目录,调整文件组织结构

* Reorder "插件 SDK API" section in docs.json

* Refactor and clarify various documentation sections

* Refine warnings and info boxes across multiple docs

* Refactor and simplify Japanese documentation content

* Update package.json to include mintlify as a dependency and add pnpm-lock.yaml for dependency management

* Update blog link and add description in docs.json

---------

Co-authored-by: Junyan Chin <[email protected]>
2026-02-21 23:55:53 +08:00