Commit Graph
51 Commits
Author SHA1 Message Date
RockChinQ 942ef7c788 feat(web): integrate ecosystem social preview images 2026-10-02 02:16:38 +00:00
RockChinQ 8da464933a docs(plugin): reorder certification and migration navigation 2026-09-28 12:39:10 +00:00
RockChinQ 689da21f46 merge: integrate docs 4.11 into main 2026-09-24 02:39:29 +08:00
RockChinQ 17b6923449 design: use clean branded documentation social preview 2026-09-21 11:11:21 +00:00
RockChinQ 124557f560 docs(plugin): document certified plugin releases (#134) 2026-09-20 18:31:22 +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
QuasarRyan ef9154d982 feat(docs): add mattermost platform usage guide (#125) 2026-09-09 10:35:20 +08:00
Hyuanddadachann a7bca0cdba feat: improve documentation sidebar quick links (#119)
* feat: improve documentation sidebar quick links

* test: update sidebar navigation expectations

---------

Co-authored-by: dadachann <[email protected]>
2026-09-05 12:21:22 +08:00
dadachann 3a28c45452 chore: keep migration notice on legacy branch only 2026-09-04 15:39:17 +00:00
dadachann a474acc7f6 docs: announce documentation migration 2026-09-04 15:19:09 +00:00
Hyuanddadachann 2e88ffb975 docs: localize header navigation (#116)
Co-authored-by: dadachann <[email protected]>
2026-09-02 23:34:14 +08:00
Hyuanddadachann 1fd6c29cc5 [verified] feat: synchronize Blog articles into Wiki (#113)
Co-authored-by: dadachann <[email protected]>
2026-08-26 02:05:29 +08:00
Hyuanddadachann 35a2843ac2 fix(seo): improve docs indexing and localization (#103)
Co-authored-by: dadachann <[email protected]>
2026-07-25 14:40:37 +08:00
RockChinQ d92af4ac35 docs: update blog link to main site 2026-07-09 14:13:17 -04:00
Hyu eab3149f1d docs: add deployment troubleshooting page 2026-07-04 14:43:33 +08:00
Junyan Chin 00a1896bd9 docs(platforms): HTTP Bot adapter tutorial (zh/en/ja) (#98)
* docs(platforms): add HTTP Bot adapter tutorial (zh/en/ja)

Server-to-server HTTP integration guide for the new http_bot platform
adapter: signed inbound webhook, signed outbound callbacks, N->1 aggregation,
1->M multi-reply, session reset, sync convenience mode, error codes, and a
5-minute reference-client demo. Registered in docs.json nav for all three
locales; adds the platform icon.

* docs(http-bot): link the interactive playground in all locales

Add a section pointing at examples/http-bot/playground.py (browser debug
console: sign -> POST -> 202 -> live callbacks) ahead of the CLI reference
clients, in zh/en/ja.

* style(platforms): use </> code icon for http-bot logo
2026-06-22 11:15:07 +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 3c950c23c3 docs(deploy): add Kubernetes deployment guide (zh/en/ja)
Add a Kubernetes deployment page covering the Box sandbox runtime under
k8s: the langbot-box component, the same-absolute-path constraint for the
Box workspace root (hostPath + podAffinity), the explicit
BOX__RUNTIME__ENDPOINT Service name, security implications of mounting
the node Docker socket, and readiness checks. Register the page in the
Installation group for all three languages.
2026-06-07 11:19:07 -04:00
Typer_Body 25ebadca5d feat: add WeKnora and DeerFlow pipeline docs with i18n support 2026-06-07 21:12:45 +08:00
RockChinQ 3dec4a6925 docs(develop): add single-page AI assistant context for developers (zh/en/ja) 2026-06-07 08:51:12 -04:00
RockChinQ bd34ad6acb docs(nav): move plugin-runtime page into Core Development after dev-config 2026-06-07 08:43:11 -04:00
99185d0b1d Feat/sandbox (#94)
* docs: add sandbox documentation for all languages

Add comprehensive documentation for the code sandbox feature:
- Overview, built-in tools, scope and lifecycle
- Backend configuration (Docker/Nsjail/E2B)
- Security profiles (default/offline_readonly/network_basic/network_extended)
- Complete configuration reference

Languages: zh, en, ja

* docs: add skills documentation for all languages

Add comprehensive Skills system documentation covering:
- Design philosophy and industry practices comparison (Claude Code, OpenAI GPTs, Cursor)
- Layered architecture (management, import, execution layers)
- Current activation mechanism ([ACTIVATE_SKILL:] marker) with TODO for future Tool Call optimization
- Agent Skills open standard compliance with field specifications
- Complete tools API reference

Languages: zh, en, ja

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

* docs: update sandbox documentation to include new tools and configuration options

* Refactor Skills API documentation to align with Tool Call mechanism

- Updated the overview of the Skills system to emphasize the Tool Call mechanism for activating and registering skills.
- Removed deprecated tools and consolidated functionality into `activate` and `register_skill`.
- Revised usage examples and parameters for the new tools, ensuring clarity on their requirements and expected responses.
- Enhanced descriptions of the activation process, including the injection of skill instructions and mounting of skill packages.
- Improved error handling documentation for better user guidance.
- Added notes on sandbox requirements for tool usage and the creation of new skills.

* docs: align sandbox runtime guides

* docs: align sandbox & skills guides with current Box implementation

Correct five inaccuracies across the zh/en/ja sandbox and skills docs so
they match the actual code:

- Box launch command: use the lbp CLI subcommand
  (`langbot_plugin.cli.__init__ box`) instead of the removed
  `langbot_plugin.box --mode ws`.
- Environment variables: replace the obsolete `LANGBOT_BOX_LOCAL_*`
  vars with the unified `SECTION__SUBSECTION__KEY` override convention
  (`BOX__LOCAL__*`); note that the langbot_box service reads no
  config.yaml/env and is configured by LangBot over INIT RPC.
- Skills: drop the stale "falls back to data/skills" claims — the Box
  Runtime is the sole source of skills; when Box is unavailable the
  skill list is simply empty.
- Document the new `box.enabled` master switch (default true) and what
  it gates.
- Document that the langbot_box compose service is optional, gated
  behind the `box`/`all` compose profile.

* docs: align sandbox docs with implementation

* docs: simplify sandbox naming and diagrams

* docs: shorten AI capability nav labels

* docs: merge sandbox configuration pages

* docs: document BOX__BACKEND as sole backend selector

* docs: recommend all profile for docker deploy

* docs: add docker permission fix for sandbox

* chore(skills): add obra/superpowers writing-skills

Install the writing-skills skill from obra/superpowers via
`npx skills add`. Lands the skill files under .agents/skills/
(universal layout) with a Claude Code symlink at .claude/skills/
and the pin in skills-lock.json.

Also gitignore .claude/settings.local.json since it's per-user
Claude Code state (skill symlinks under .claude/skills/ remain
tracked).

* docs(sandbox,skills): tighten user guides for onboarding

Rewrite the sandbox and skills user guides to be shorter, plainer, and
focused on getting users productive instead of explaining internals.

Changes per page (zh/en/ja kept in lockstep):

- sandbox/readme: 170 → 73 lines. Drop the "what is a sandbox" essay,
  decorative mermaid, and the backend table that already lives in
  config.mdx. Lead with the six built-in tools and the scope picker
  (the parts users actually configure).
- sandbox/runtime-relationships: 75 → 54 lines. Replace the runtime
  prose with a single comparison table; tighten the troubleshooting
  entry-points.
- skills/readme: 320 → 114 lines. Cut the "design philosophy" /
  "industry comparison" / "KV cache theory" sections — those are
  implementation details users don't need to ship. Lead with the
  user-visible flow (Agent reads <available_skills> → calls activate →
  follows the SKILL.md).
- skills/skill-format: 360 → 134 lines. One excellent example
  (api-tester) instead of three overlapping ones. Drop the standalone
  "field details" subsections that just restate the table.
- skills/tools-api: 200 → 122 lines. Drop the old-vs-new historical
  comparison and the duplicated activation section; keep the two tool
  signatures, parameters, returns and errors.

sandbox/config.mdx left untouched (already condensed upstream).

Principles applied come from obra/superpowers writing-skills (installed
in 08c35a4): lead with use, one excellent example, tables for scanning,
cut internals and history.

* docs(sandbox): drop redundant 'how to choose' table from runtime-relationships

The 对照表 above already has a '何时使用 / When to use' column that says
the same thing. Repeating it as a second 怎么选 / How to Choose table
was pure noise.

* docs(skills): collapse to one page, link out for SKILL.md spec

Delete skill-format.mdx and tools-api.mdx — Skills now has a single
page. The format details and tools reference were already covered in
shorter form inside readme.mdx; the separate pages were repetition.

In readme.mdx:
- Inline a compact 'SKILL.md format' section (one example + a three-
  field table) and point at agentskills.io for the canonical spec.
- Drop the 'next steps' section and the tools-api link, since both
  destinations no longer exist.

docs.json: remove the two pages from each locale's Skills nav. Add
redirects from the old paths to readme so existing links don't 404.

* docs(nav): flatten Skills — single page, no group wrapper

Group with one child is just visual noise in the sidebar. Replace
{ group: Skills, pages: [...readme] } with the readme path directly
in the parent AI Configuration group, in all three locales.

* docs(mcp,skills): lead with LangBot Space as the preferred install path

LangBot Space (https://space.langbot.app) now hosts a curated list of
MCP servers and Skills. Surface that as the first install option in
both user guides.

- usage/mcp/readme: rework the intro Info block to recommend LangBot
  Space first (third-party channels demoted to "alternative source").
  Add a "Install from LangBot Space (Preferred)" section above the
  existing manual flow; rename that flow to "Add MCP Server Manually".
- usage/skills/readme: add a "Install from LangBot Space (Preferred)"
  section above "Creating a Skill"; rename the existing section to
  "Creating a Custom Skill" so the contrast is clear.

zh/en/ja kept in sync.

* docs(skills): reorganize the readme around the user journey

The old structure interleaved "what it is" → "how it works internally"
→ "prerequisites" → "format spec" → install options. Reorder around
how users actually approach the page:

  Intro → compare with plugins/MCP → install → enable → write → debug

Specific moves:
- Drop the standalone "Workflow" flow diagram; fold the one important
  point (activation pulls SKILL.md via Tool Result) into the intro.
- Merge the standalone "Prerequisites" section into a short Note on the
  Install heading — that's where the constraint actually applies.
- Bring "Install from LangBot Space" and "Create your own" together
  under one "Install" H2 with H3 subsections; they were sibling H2s
  before, which buried the relationship.
- Move "Writing a SKILL.md" after install + enable, since most users
  start with marketplace skills.
- Demote the "Tools the Agent sees" table to an H3 inside the writing
  section — it's reference, not a top-level concern.

114 → 100 lines, zh/en/ja in lockstep.

* docs(mcp,models): reorder MCP page + move tool-use capability to Models

Two related changes, same as the Skills cleanup pattern:

usage/mcp/readme — reorganize around the user journey
- Drop the standalone "Enable function calling on the model" section;
  that belongs in the Models doc (it's not MCP-specific — sandbox tools
  and Skills depend on the same model capability).
- Drop the redundant "Effect" section — its one fact (built-in Agent +
  tool-use model) already lives in the Note under "Three Transport
  Modes".
- Group install paths under one "Installing an MCP Server" H2 with
  Space (preferred) and manual flows as H3 siblings, mirroring the
  Skills doc layout.
- Move the stdio MCP technical block under a clearly-labeled
  "Advanced: stdio MCP" H2 so casual readers skim past it.
- Trim screenshot duplication and collapse three steps in the manual
  flow into one paragraph + one screenshot per step.
- 140 → 107 lines, zh/en/ja kept in lockstep.

usage/models/readme — rename and expand "function calling" → "tool use"
- The checkbox is renamed to "Tool Use" (zh: 工具使用能力 / ja: ツール
  使用); function calling kept in parentheses for recognition.
- Expand the bullet into a Note that explicitly lists where the
  capability matters: MCP servers, sandbox built-ins (exec/read/write/
  edit/glob/grep), Skills. Without it, even bound extensions stay
  silent.
- Note that the underlying model must actually support function
  calling for the checkbox to take effect.

* docs(sandbox): point sandbox/config readers to System Environment Settings

The page lists box.* YAML blocks without ever telling the reader where
those settings actually go. Add a one-line Note at the top linking to
deploy/settings (System Environment Settings), where the data/config.yaml
location and load mechanism are documented.

* docs(sandbox/config): align the page with the real config structure

The previous version listed local / docker / nsjail / e2b as four
parallel "backends" in one flat table. That's wrong: looking at the
config template and the SDK's _select_backend, the real model is:

- box.backend accepts 'local' | 'docker' | 'nsjail' | 'e2b'
- 'local' is shorthand for "auto-pick from Docker / Nsjail" — not a
  fourth backend
- 'local', 'docker', 'nsjail' all *share* the box.local.* config
  section; the section is misleadingly named ("local" here means
  "host-local backends", not "for backend: 'local'")
- 'e2b' uses box.e2b.* instead
- 'local' is the only value that auto-falls-back; everything else is a
  hard selection

Rewrite the page around that structure:
- Group backends as "local containers" vs "cloud" with the four values
  inside, and call out the local-vs-fourth-backend distinction.
- Split the old single "common settings" table into two clearly-scoped
  tables: box.local.* (for local backends) and box.e2b.* (for cloud).
- Move box.runtime.endpoint into the Docker Compose section, where it
  actually matters.
- Add an explicit note that backend is a hard selection — only 'local'
  fans out.

zh/en/ja kept in lockstep.

* docs(deploy): note Box control-plane transport differs by deploy method

In Docker deployments the Box control plane runs as the langbot_box
container (WebSocket); manual / uvx deployments use a stdio subprocess.
Also clarify the LangBot image bundles the docker client so langbot_box
can create sandbox containers via the mounted socket without extra setup.
zh / en / ja.

---------

Co-authored-by: Claude Opus 4.7 <[email protected]>
Co-authored-by: Junyan Qin <[email protected]>
2026-06-04 20:18:29 +08:00
RockChinQ 57ba9ed7e1 docs: use image icons for bot navigation 2026-05-18 12:31:00 +08:00
RockChinQ ca5a1fb816 docs: add platform icons to all locales 2026-05-18 12:16:21 +08:00
RockChinQ 6f0e857d0e docs: normalize platform icon colors 2026-05-18 12:05:15 +08:00
RockChinQ fa8267d7f5 docs: use real platform icons 2026-05-18 11:59:45 +08:00
RockChinQ e0b729f9be docs: add platform icons to bot config navigation 2026-05-18 11:35:02 +08:00
fdc310 4422f83e27 docs: add webpage platform support for English, Chinese, and Japanese 2026-05-15 00:10:58 +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
Junyan QinandClaude Opus 4.6 3d1d97ecca docs: add Page component tutorial (zh + en)
Add comprehensive Page component documentation covering:
- Use cases (admin panels, data displays, interactive tools)
- Manifest file format
- Backend handler with PageRequest/PageResponse
- Frontend development with Page SDK (API calls, dark mode, i18n)
- Full FAQ Manager example
- Update add.mdx and docs.json navigation for both languages

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
2026-04-25 21:59:17 +08:00
Junyan Qin 0a2c7bdfc8 docs(zh): reorder platform sidebar and add personal WeChat entry 2026-03-31 00:43:34 +08:00
Junyan Chin ff93edb43b fix(seo): add wildcard redirects to fix 390 GSC 404 errors (#90)
- Add deploy/* → usage/* wildcard redirects for all 3 locales (en/zh/ja)
  covering platforms, models, pipelines, knowledge, mcp paths
- Add no-locale → /en/ redirects for old VitePress paths without
  locale prefix (insight, plugin, deploy, workshop, develop, usage)
- Add catch-all redirects for deprecated paths (config, webui, posts,
  session, pipeline, i18n, development) → guide page
- Add /README_EN → /en/insight/guide redirect (duplicate content fix)
- Add /api/v1/* → /en/api-reference/* redirect (crawled API endpoints)
- Remove 12 redundant specific redirects now covered by wildcards

Addresses GSC coverage report showing 390 not-found pages and
declining index coverage (473→428 indexed, 472→930 not-indexed).
2026-03-26 11:19:45 +08:00
fdc310 fd9f838840 Merge branch 'main' of github.com:langbot-app/Langbot-Wiki 2026-03-25 23:36:48 +08:00
fdc310 412452dbef doc: add wexin adapter docs 2026-03-25 23:36:28 +08:00
RockChinQ 13e74e4fbf feat(seo): add description, seo indexing, and OG metatags for GEO optimization 2026-03-24 17:53:27 +08:00
RockChinQ 23133ee5eb chore: add Google Search Console meta tag verification 2026-03-24 14:11:59 +08:00
RockChinQ 00d7d12130 docs: add data collection policy (en/zh/ja) 2026-03-11 06:49:19 -04: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
RockChinQ 4e06891580 fix: repair docs.json syntax error 2026-02-25 09:19:58 -05:00
Junyan Chin 7c07dc8ee0 docs: add LangBot Cloud references (#85)
* docs: add LangBot Cloud references to guide pages and navbar

* docs: add LangBot Cloud reference to Japanese guide
2026-02-25 22:15:11 +08:00
CopilotandRockChinQ 0071e7655c Make English the default docs language (#83)
* Initial plan

* feat: make English the default docs page by moving en first in navigation languages

Co-authored-by: RockChinQ <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: RockChinQ <[email protected]>
2026-02-24 18:08:43 +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
Junyan Qin 6b6d9c0e19 Update group name in docs.json and refine warning message in community.mdx 2026-02-23 15:20:41 +08:00
Typer_Body f4593f8599 Update docs.json 2026-02-22 22:25:22 +08:00
RockChinQ 1ffcdafdf9 docs: optimize SEO description for DeepSeek & Dify integration 2026-02-21 23:25:33 -05:00
Junyan Chin 3be65995aa Add font family to docs.json 2026-02-21 11:06:01 -05:00
Junyan Chin 569b8ffbaa Add Noto Sans SC to docs.json font family 2026-02-21 11:03:43 -05:00