OneCX Documentation

Welcome to the OneCX documentation hub for contributors and users. This page is your entry point to the guides, conventions, and tooling used to write and publish OneCX documentation.

Purpose

The goal of this guide is to keep documentation simple, consistent and easy to maintain across the OneCX ecosystem. We author content in AsciiDoc and publish sites using Antora.

Audience

Developers and technical writers authoring or reviewing docs
Product owners wanting an overview of available guides
Contributors integrating new modules or updating existing content

Authoring Guidelines

Follow the general guidelines in OneCX Docs: Guidelines.
For writing style guidelines, see OneCX Docs: Writing Style.
For formatting and conventions, see OneCX Docs: Formatting.

Getting Started

To set up your local environment for writing and previewing OneCX documentation, follow the instructions in OneCX Docs: Local Setup.

Reference

See the OneCX Local Environment - it is our reference implementation for structure, style and conventions.