docs: make enterprise/embedded integration discoverable from the repo - #2066
docs: make enterprise/embedded integration discoverable from the repo#2066xiahjay wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughREADME navigation and onboarding sections were updated in English and Chinese, and ChangesDocumentation guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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
1e516f1 to
17b297c
Compare
|
|
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 init→auth login), so anyone evaluating the tool on GitHub cannot discover the enterprise path: neitherextension,enterprisenorembedappears anywhere in the README.Changes
Content stays on the doc site (single source of truth); the repo only gains signposts:
extension/. Also adds an Enterprise entry to the nav bar, and a one-line tip that appending.mdto any Open Platform doc URL returns raw Markdown (useful for AI Agents).credential/,transport/,platform/) to the six extension points and points to the existingplatform/README.mdPlugin 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
.mdto Open Platform documentation URLs.