docs: add Octo IM integration page (en/zh/ja/ko)#30
Merged
Conversation
Octo had no user-facing docs page while Lark has one. Add a parallel
page mirroring lark-bot-integration's structure, but written to Octo's
actual behavior (not a copy):
- bot-token configuration (paste a bf_* token), not a QR scan
- chat-only — explicitly no /issue command (Octo has no issue-command
path; that's Lark-specific)
- plain Markdown replies with in-place streaming edits, not interactive
cards
- identity binding via {MULTICA_PUBLIC_URL}/octo/bind?token= link
- one bot ↔ one agent, deployment-wide unique
- self-host: MULTICA_OCTO_SECRET_KEY (required), MULTICA_OCTO_API_URL
(optional default), MULTICA_PUBLIC_URL (binding link)
Registered in all 4 meta navs under Integrations, right after Lark.
docs typecheck (fumadocs-mdx) clean.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Octo had no user-facing documentation page while Lark has one (
lark-bot-integration). This adds a parallel Octo IM integration page in all four locales (en / zh / ja / ko), registered in the docs nav under Integrations, right after Lark.Written to Octo's actual behavior (not a Lark copy)
The structure mirrors the Lark page, but every section reflects how Octo really works — I verified each against the code:
bf_*token + optional API URL), not a QR scan / device flow./issuecommand. Octo's dispatcher has no issue-command path (that's Lark-specific); the page calls this difference out so users don't expect it.{MULTICA_PUBLIC_URL}/octo/bind?token=…link (single-use, 15 min).MULTICA_OCTO_SECRET_KEY(required to enable),MULTICA_OCTO_API_URL(optional default),MULTICA_PUBLIC_URL(makes the binding link clickable) — matching the actual router wiring.Validation
pnpm --filter @multica/docs typecheck(runsfumadocs-mdx+tsc) is clean — all four MDX pages compile and the nav metas parse. Change set is exactly 4 new pages + 4 one-line nav additions; nothing else touched.