Skip to content

docs: make enterprise/embedded integration discoverable from the repo - #2066

Open
xiahjay wants to merge 1 commit into
larksuite:mainfrom
xiahjay:docs/enterprise-integration-discoverability
Open

docs: make enterprise/embedded integration discoverable from the repo#2066
xiahjay wants to merge 1 commit into
larksuite:mainfrom
xiahjay:docs/enterprise-integration-discoverability

Conversation

@xiahjay

@xiahjay xiahjay commented Jul 27, 2026

Copy link
Copy Markdown

Problem

Enterprise IT developers repeatedly report they don't know how to centrally integrate lark-cli into their own Agents/platforms. The capability exists and is documented — the extension mechanism (Credential / Transport / Restrict / Observer / Wrap / On) has a full guide on the Open Platform doc site (Embed lark-cli in your Agent) and the code is open-sourced under extension/ — but the repo never mentions it. The README is written entirely from the individual-developer perspective (config initauth login), so anyone evaluating the tool on GitHub cannot discover the enterprise path: neither extension, enterprise nor embed appears anywhere in the README.

Changes

Content stays on the doc site (single source of truth); the repo only gains signposts:

  • README.md / README.zh.md — add a small "Personal or Enterprise?" routing table right after Why lark-cli?: individual developers continue to Quick Start, enterprise IT / ISV get a direct link to the official embedding guide and extension/. Also adds an Enterprise entry to the nav bar, and a one-line tip that appending .md to any Open Platform doc URL returns raw Markdown (useful for AI Agents).
  • extension/README.md (new, thin index) — maps the packages (credential/, transport/, platform/) to the six extension points and points to the existing platform/README.md Plugin SDK guide plus the official doc. Helps engineers who evaluate via source / pkg.go.dev.

No code changes; 3 files, +33/−2.

Summary by CodeRabbit

  • Documentation
    • Updated English and Chinese README navigation with a new section for choosing between personal use and enterprise integration.
    • Added guidance and a recommendation table for individual developers versus enterprise IT/ISVs.
    • Included a note for AI agents on fetching raw Markdown by appending .md to Open Platform documentation URLs.
    • Expanded the extension embedding guide, covering integration points and linking to full embedding documentation.

@github-actions github-actions Bot added the size/S Low-risk docs, CI, test, or chore only changes label Jul 27, 2026
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8ed4dbb1-226b-4f2c-a0c2-63867c58378c

📥 Commits

Reviewing files that changed from the base of the PR and between 1e516f1 and 17b297c.

📒 Files selected for processing (3)
  • README.md
  • README.zh.md
  • extension/README.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • extension/README.md
  • README.md
  • README.zh.md

📝 Walkthrough

Walkthrough

README navigation and onboarding sections were updated in English and Chinese, and extension/README.md now documents embedding lark-cli through credential, transport, and platform extension points.

Changes

Documentation guidance

Layer / File(s) Summary
Onboarding navigation and paths
README.md, README.zh.md
Table-of-contents links and personal, enterprise, and AI-agent documentation guidance were added or adjusted.
Extension embedding documentation
extension/README.md
The extension model and credential, transport, and platform integration points are documented with a link to the full embedding guide.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: caojie0621

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main doc change: exposing enterprise and embedded integration from the repo.
Description check ✅ Passed The description covers the motivation and main changes, but it doesn't match the template exactly because it lacks Summary, Test Plan, and Related Issues sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The embedding guide (extension mechanism: Credential / Transport /
Restrict / Observer / Wrap / On) lives on the Open Platform doc site,
but the repo itself never mentions it — enterprise IT scanning GitHub
cannot discover the centralized-integration path at all.

- README(.zh): add a 'Personal or Enterprise?' routing table right
  after 'Why lark-cli?', linking the official embedding guide and
  extension/; add 'Enterprise' to the nav bar; document the '.md'
  raw-Markdown trick for AI Agents
- extension/README.md: thin index mapping packages to extension
  points, pointing to platform/README.md and the official guide
@xiahjay
xiahjay force-pushed the docs/enterprise-integration-discoverability branch from 1e516f1 to 17b297c Compare July 27, 2026 09:59
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Low-risk docs, CI, test, or chore only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants