Update documentation (#576)

Documentation overhaul

Author: chhwang

README.md

@@ -5,17 +5,19 @@
 [![CodeQL](https://github.com/microsoft/mscclpp/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/microsoft/mscclpp/actions/workflows/codeql-analysis.yml)
 [![Docs Build](https://github.com/microsoft/mscclpp/actions/workflows/doc-build.yaml/badge.svg)](https://microsoft.github.io/mscclpp/)
 
-| Pipelines                | Build Status      |
+| Testing Pipelines        | Build Status      |
 |--------------------------|-------------------|
 | Unit Tests (CUDA)        | [![Build Status](https://msazure.visualstudio.com/One/_apis/build/status%2FCustom%2FMSCCLPP%2Fmscclpp-ut?branchName=main)](https://msazure.visualstudio.com/One/_build/latest?definitionId=398325&branchName=main) |
 | Integration Tests (CUDA) | [![Build Status](https://msazure.visualstudio.com/One/_apis/build/status%2FCustom%2FMSCCLPP%2Fmscclpp-test?branchName=main)](https://msazure.visualstudio.com/One/_build/latest?definitionId=398479&branchName=main) |
 | Integration Tests (ROCm) | [![Build Status](https://dev.azure.com/msazure/One/_apis/build/status%2FCustom%2FMSCCLPP%2Fmscclpp-test-rocm?branchName=main)](https://dev.azure.com/msazure/One/_build/latest?definitionId=399295&branchName=main) |
 
 A GPU-driven communication stack for scalable AI applications.
 
-See [Quick Start](https://microsoft.github.io/mscclpp/getting-started/quickstart.html) to quickly get started.
-
-Check our [paper](https://arxiv.org/abs/2504.09014) to know more about MSCCL++.
+| [Quick Start](https://microsoft.github.io/mscclpp/quickstart.html)
+| [Tutorials](https://microsoft.github.io/mscclpp/tutorials.html)
+| [API Reference](https://microsoft.github.io/mscclpp/cpp_api.html)
+| [Paper](https://arxiv.org/abs/2504.09014)
+|
 
 ## Overview
 

docs/Doxyfile

@@ -44,7 +44,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "GPU-driven computation & communication stack"
+PROJECT_BRIEF          = "GPU-driven communication stack"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -2163,7 +2163,7 @@ ENABLE_PREPROCESSING   = YES
 # The default value is: NO.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
 # the macro expansion is limited to the macros specified with the PREDEFINED and
@@ -2203,7 +2203,17 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = __CUDACC__
+PREDEFINED             = __CUDACC__ \
+                         MSCCLPP_DEVICE_COMPILE \
+                         MSCCLPP_DEVICE_CUDA \
+                         MSCCLPP_DEVICE_HIP \
+                         MSCCLPP_DEVICE_INLINE= \
+                         MSCCLPP_HOST_DEVICE_INLINE= \
+                         MSCCLPP_INLINE= \
+                         __forceinline__= \
+                         __device__= \
+                         __host__= \
+                         __global__=
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

docs/_static/.gitkeep

@@ -7,14 +7,14 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "mscclpp"
-copyright = "2024, MSCCL++ Team"
+copyright = "2025, MSCCL++ Team"
 author = "MSCCL++ Team"
 release = "v0.7.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["breathe", "myst_parser"]
+extensions = ["breathe", "myst_parser", "sphinxcontrib.mermaid"]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
@@ -23,6 +23,10 @@
 breathe_projects = {"mscclpp": "./doxygen/xml"}
 breathe_default_project = "mscclpp"
 
+# Mermaid configuration
+mermaid_version = "11.0.0"
+mermaid_init_js = "mermaid.initialize({startOnLoad:true});"
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output