index.rst

Logging Documentation

This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust logging module.

Table of Contents

• Overview
• Requirements
• Project Layout
• Quick Start
• Configuration
• Additional documentation

Overview

This repository provides a standardized setup for projects using C++ or Rust and Bazel as a build system. It integrates best practices for build, test, CI/CD and documentation.

Requirements

.. stkh_req:: Example Functional Requirement
   :id: stkh_req__docgen_enabled__example
   :status: valid
   :safety: QM
   :security: YES
   :reqtype: Functional
   :rationale: Ensure documentation builds are possible for all modules

Project Layout

The logging module includes the following top-level structure:

• score/: Main C++/Rust sources
• tests/: Unit and integration tests
• examples/: Usage examples
• docs/: Documentation using docs-as-code
• .github/workflows/: CI/CD pipelines

Quick Start

To build the module:

bazel build //score/...

To run tests:

bazel test //tests/...

Configuration

The project_config.bzl file defines metadata used by Bazel macros.

Example:

PROJECT_CONFIG = {
    "asil_level": "QM",
    "source_code": ["cpp", "rust"]
}

This enables conditional behavior (e.g., choosing clang-tidy for C++ or clippy for Rust).

Additional documentation

.. toctree::
   :maxdepth: 1

   /docs/features/logging/architecture/index
   /docs/design_decisions/explicit_init