Skip to content

docs: add documentation for Feishu/Lark cloud document parser #859

@qin-ctx

Description

@qin-ctx

Background

PR #831 added Feishu/Lark cloud document parsing support (docx, wiki, sheets, bitable). The feature is implemented and tested, but documentation has not been updated yet.

Tasks

Resource docs (docs/{en,zh}/api/02-resources.md)

  • Add Feishu entry to the "Supported Formats" table (e.g., Feishu | URL | Cloud document parsing via lark-oapi)
  • Add a Feishu URL usage example in the add_resource() section:
    client.add_resource("https://example.feishu.cn/docx/doxcnABC123")

Configuration docs (docs/{en,zh}/guides/01-configuration.md)

  • Document the feishu config section in ov.conf:
    {
      "feishu": {
        "app_id": "",
        "app_secret": "",
        "domain": "https://open.feishu.cn",
        "max_rows_per_sheet": 1000,
        "max_records_per_table": 1000
      }
    }
  • Document environment variable alternatives: FEISHU_APP_ID, FEISHU_APP_SECRET
  • Note the optional dependency: pip install 'openviking[bot-feishu]'

Supported document types

Document the four supported Feishu URL patterns:

  • https://*.feishu.cn/docx/{id} — Documents
  • https://*.feishu.cn/wiki/{token} — Wiki pages (auto-resolved to underlying type)
  • https://*.feishu.cn/sheets/{token} — Spreadsheets
  • https://*.feishu.cn/base/{token} — Bitable (multi-dimensional tables)

Also mention Lark international URLs (*.larksuite.com).

Context

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions