You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Open-IM-Server/docs
Xinwei Xiong 18f14c9722
Update go-code.md (#1980)
10 months ago
..
contrib Update go-code.md (#1980) 10 months ago
contributing feat: add architecture layers (#1860) 11 months ago
images feat: add architecture layers (#1860) 11 months ago
readme docs/README_el (#1929) 10 months ago
.generated_docs feat(main): 🚀 Database Name Correction and S3 Module Int32 Overflow Fix with Go Routine Integration for Automated Checks and Script Optimization (#1799) 11 months ago
CODEOWNERS docs: add rfyiamcool to code_owners (#1491) 1 year ago
README.md feat: add architecture layers (#1860) 11 months ago

README.md

OpenIM Server Docs

Welcome to the OpenIM Documentation hub! This center provides a comprehensive range of guides and manuals designed to help you get the most out of your OpenIM experience.

Table of Contents

  1. Contrib - Guidance on contributing and configurations for developers
  2. Conversions - Coding conventions, logging policies, and other transformation tools

Contrib

This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes.

Conversions

This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more.

For Developers, Contributors, and Community Maintainers

Developers & Contributors

If you're a developer or someone keen on contributing:

Community Maintainers

As a community maintainer:

  • Ensure that contributions align with the standards outlined in our documentation.
  • Regularly review the Logging Policy and Error Codes to stay updated.

For Users

Users should pay particular attention to:

  • Docker Installation - Necessary if you're planning to use Docker images of OpenIM.
  • Docker Image Strategy - To understand the different images available and how to choose the right one for your architecture.