This repository contains the source for the official OpenIM documentation. It provides implementation guides and API documentation for OpenIM client SDKs and the server-side Platform API in English and Simplified Chinese.
OpenIM is an open-source instant messaging infrastructure for building messaging, group chat, realtime event, and audio/video calling experiences into applications. Product source code and SDK repositories are maintained by the OpenIMSDK organization.
| Resource | Link |
|---|---|
| Documentation | docs.openim.io |
| Simplified Chinese documentation | docs.openim.io/zh |
| OpenIM website | openim.io |
| Enterprise edition | openim.io/enterprise |
| OpenIMSDK on GitHub | github.com/openimsdk |
The public documentation currently covers:
- OpenIM product concepts, deployment guidance, and integration workflows
- iOS SDK
- Flutter SDK
- Electron SDK
- JavaScript SDK for lightweight Web and Mini Program runtimes
- JavaScript SDK (WASM) for full Web IM applications and Electron renderer processes
- Platform API, including authentication, users, relationships, groups, conversations, messages, Webhooks, and operational APIs
Only reviewed platforms and pages appear in the public navigation, search index, and sitemap. Draft structures for additional platforms may remain in the repository without being published.
Capabilities marked Enterprise require the corresponding commercial edition or delivery. See the Enterprise edition for product information, or contact [email protected] for licensing and commercial support.
The documentation application is built with:
English and Simplified Chinese pages share one audited route structure. Navigation, search indexes, localized SDK packages, and publication metadata are derived from reviewed MDX and structural records.
- Node.js 22.12 or later
- Corepack
- The pnpm version declared in
package.json
corepack enable
pnpm install --frozen-lockfile
cp .env.example .env.local
pnpm devOpen the local site at:
- English: http://localhost:3000
- Simplified Chinese: http://localhost:3000/zh
api/chat/platform-api/ Versioned OpenAPI source documents
app/ Next.js routes, metadata, search, and sitemap
content/docs/ English SDK and Platform API MDX
content/en/docs/guides/ Reviewed English guide snapshots
content/zh/docs/ Simplified Chinese MDX and guide snapshots
data/structure/ Navigation, ownership, scope, and review records
docs/ Current architecture and authoring documentation
public/ Versioned images, brand assets, and downloads
scripts/ Active validation, synchronization, and build tools
src/components/ Documentation and site UI
src/generated/ Committed route, navigation, search, and locale data
Public URLs do not expose internal product-version directories. For example:
/sdk/wasm/overview
└── content/docs/chat/sdk/wasm/overview.mdx
/zh/sdk/wasm/overview
└── content/zh/docs/chat/sdk/wasm/overview.mdx
Generated files are build inputs, not editorial evidence. Documentation facts must be verified against the pinned OpenIM SDK declarations, OpenIMServer definitions, OpenAPI documents, or the immutable sources recorded in the relevant audit file.
Read CONTRIBUTING.md and the content authoring guide before changing documentation pages.
The client SDK localization workflow is Chinese-first:
- Review the complete Simplified Chinese page and its technical evidence.
- Edit and audit the page manually.
- Translate the reviewed page into fluent English.
- Verify API names, parameters, examples, results, events, and links against the target SDK.
- Publish the English route only after its review record is complete.
Final MDX prose must be reviewed page by page. Scripts may update deterministic structure and generated metadata, but they must not generate or machine-translate final documentation text.
Run the complete validation suite before submitting or publishing changes:
pnpm check
pnpm buildpnpm check includes linting, TypeScript validation, content integrity checks, SDK publication audits, example checks, OpenAPI linting, and Platform API tests. pnpm build validates the production application. Local and Docker builds also prepare the standalone server output; managed platforms use their own Next.js runtime.
Frequently used commands:
| Command | Purpose |
|---|---|
pnpm dev |
Synchronize derived content and start the development server. |
pnpm content:status |
Report publication status by product and page type. |
pnpm content:sync |
Rebuild localized SDK packages and search indexes. |
pnpm content:metadata |
Refresh route and navigation metadata from reviewed frontmatter. |
pnpm content:check |
Validate routes, links, navigation, frontmatter, and search records. |
pnpm structure:report |
Refresh the active route and navigation report. |
pnpm check |
Run the complete quality and content validation suite. |
pnpm build |
Create the production Next.js build and standalone output. |
Copy .env.example to .env.local for local development. The following public environment variables configure canonical URLs and external navigation:
NEXT_PUBLIC_SITE_URL=https://docs.openim.io
NEXT_PUBLIC_WEBSITE_URL=https://openim.io/
NEXT_PUBLIC_ENTERPRISE_URL=https://openim.io/enterprise/
NEXT_PUBLIC_GITHUB_URL=https://github.com/openimsdk
NEXT_PUBLIC_EDIT_BASE_URL=https://github.com/openimsdk/docs/edit/mainLeave NEXT_PUBLIC_EDIT_BASE_URL empty if edit links should not be displayed.
The production site at docs.openim.io is deployed from main through Netlify. netlify.toml fixes the build command, publish directory, Node.js version, and Next.js Runtime in version control.
Every production deployment must reach ready and pass smoke tests for the home pages, SDK and Platform API routes, search, redirects, Sitemap, and Robots. See the deployment audit for the verified production chain.
The repository includes vercel.json. Configure the production environment variables, import the repository into Vercel, and use the committed pnpm lockfile. Vercel runs:
pnpm install --frozen-lockfile
pnpm buildBuild and run the maintained container image with:
docker compose up --buildFor a direct Node.js deployment:
corepack enable
pnpm install --frozen-lockfile
pnpm build
PORT=3000 HOSTNAME=0.0.0.0 pnpm startThe production server is generated at .next/standalone/server.js.
Contributions that improve correctness, examples, navigation, accessibility, or developer experience are welcome. Pull requests should identify the affected documentation area, the SDK or server evidence used, and the validation commands that were run.
See:
Use GitHub Issues for reproducible documentation defects and content corrections. For product, deployment, licensing, or commercial support, contact [email protected].
Do not report security vulnerabilities in a public issue. Follow the private reporting process in SECURITY.md.
This documentation project is licensed under the MIT License.