Maintainer Documentation¶
Comprehensive documentation, workflows, build matrix, and release procedures for siddiqsoft::sip2json maintainers and contributors.
Maintainer Topics¶
flowchart TD
MG["Maintainer Guide (maintainer_guide.md)"]
MG --> WF["Local Workflow (workflow.md)"]
MG --> CP["CMake Presets (cmake_presets.md)"]
MG --> PL["CI/CD Pipelines (pipelines.md)"]
MG --> BA["Build Agents (build_agents.md)"]
MG --> RL["Release Lifecycle (releases.md)"]
MG --> DC["Documentation (documentation.md)"]Directory of Guides¶
| Guide | Description |
|---|---|
| Maintainer Guide | Codebase architecture, UML directive grammar (@@uml-diag:), class diagrams, and bulk clang-format instructions |
| CI/CD Pipelines | Multi-platform pipeline architecture, platform matrix, and parameters reference |
| CMake Presets | Decoupled presets hierarchy, project-base.json, and preset reference |
| Development Workflow | Local building, testing, standalone validation subproject, and macOS toolchain management |
| Build Agent Requirements | Prerequisites and configuration for macOS, Linux, and Windows self-hosted agents |
| Release & Publication Lifecycle | GitVersion, SemVer tagging, GitHub Releases, and NuGet package publishing |
| Documentation Architecture | MkDocs Material, Doxygen XML, custom CSS tokens, hooks, and local preview |