merge

Author: Jullija

.devcontainer/api_reference.sh

@@ -102,8 +102,8 @@ clone_if_missing "https://github.com/JohelEGP/cxxdraft-htmlgen.git" "standardese
 
 # Configure CMake
 echo "Configuring CMake for API reference documentation..."
-BUILD_DIR="$PROJECT_ROOT/build/docs/api_reference"
-SOURCE_DIR="$PROJECT_ROOT/docs/api_reference/src"
+BUILD_DIR="$PROJECT_ROOT/build/docs/reference/api_reference"
+SOURCE_DIR="$PROJECT_ROOT/docs/reference/api_reference/src"
 
 if [[ ! -d "$SOURCE_DIR" ]]; then
     echo "Error: Source directory not found: $SOURCE_DIR" >&2
@@ -119,9 +119,9 @@ cmake -S "$SOURCE_DIR" \
 echo "CMake configuration completed successfully."
 
 # Create symlink for generated HTML documentation
-# This allows accessing the generated docs via docs/api_reference/gen
+# This allows accessing the generated docs via docs/reference/api_reference/gen
 echo "Creating symlink for generated documentation..."
-SYMLINK_TARGET="$PROJECT_ROOT/docs/api_reference/gen"
+SYMLINK_TARGET="$PROJECT_ROOT/docs/reference/api_reference/gen"
 SYMLINK_SOURCE="${BUILD_DIR}/mp-units.html"
 
 # Ensure the parent directory exists

.flake8

@@ -5,6 +5,8 @@ ignore =
     E711,
     # comparison to True should be 'if cond is True:' or 'if cond:'
     E712,
+    # whitespace before ':' - conflicts with Black formatter
+    E203,
     # line break before binary operator
     W503
 per-file-ignores =

.github/workflows/documentation.yml

@@ -82,12 +82,12 @@ jobs:
           git clone https://github.com/JohelEGP/cxxdraft-htmlgen.git --branch=standardese_sources_base --depth=1
       - name: Generate API reference
         run: |
-          cmake -S docs/api_reference/src -B build \
+          cmake -S docs/reference/api_reference/src -B build \
                 -DCMAKE_MODULE_PATH="${{ github.workspace }}/jegp.cmake_modules/modules" \
                 -DJEGP_STANDARDESE_SOURCES_GIT_REPOSITORY="${{ github.workspace }}/draft" \
                 -DJEGP_CXXDRAFT_HTMLGEN_GIT_REPOSITORY="${{ github.workspace }}/cxxdraft-htmlgen"
           cmake --build build
-          mv build/mp-units.html docs/api_reference/gen
+          mv build/mp-units.html docs/reference/api_reference/gen
       - name: Installing pip dependencies
         run: |
           pip install conan mkdocs-material mkdocs-rss-plugin mkdocs-material[imaging] mkdocs-exclude mike

.gitignore

@@ -28,6 +28,9 @@
 *.out
 *.app
 
+# macOS files
+.DS_Store
+
 # IDE-specific
 /.idea/
 /.vs/
@@ -48,8 +51,8 @@ CMakeUserPresets.json
 /test_package/build/
 
 # cxxdraft-htmlgen
-docs/api_reference/src/source/
-docs/api_reference/gen
+docs/reference/api_reference/src/source/
+docs/reference/api_reference/gen
 
-# macOS files
-.DS_Store
+# Generated website files
+site/

CONTRIBUTING.md

@@ -348,6 +348,23 @@ For more, see the [official documentation](https://mpusz.github.io/mp-units) and
     [cmake time-trace support]: https://github.com/mpusz/mp-units/releases/tag/v2.5.0
 
 
+## AI-Generated Contributions
+
+We welcome the use of LLMs (Large Language Models) to help you write better prose, generate
+unit test cases, or brainstorm solutions. However, to maintain the high technical standards
+of **mp-units**, we ask you to follow these rules:
+
+1. **Rationale First:** Never submit a "blind refactor." If an AI suggests a different
+  design, you must be able to explain the rationale behind it.
+2. **Review Your Diff:** Ensure the AI hasn't rewritten entire files unnecessarily.
+  Large, monolithic diffs for small changes will be rejected.
+3. **Verify Quality:** AI often suggests "average" code. Since this is a bleeding-edge
+  library using C++20/23, ensure the AI hasn't introduced legacy patterns or inefficient
+  templates.
+4. **Transparency:** If a significant portion of your PR was generated by AI, please
+  disclose it. This helps reviewers focus on correctness rather than style.
+
+
 ## Before committing git changes
 
 There are a few recommended checks before committing and pushing changes.

CONTRIBUTORS.md

@@ -32,13 +32,13 @@ wouldn't be possible without the dedication and hard work of our amazing communi
 
 ## Statistics
 
-- **Total Contributors**: 34
-- **Total Contributions**: 318
+- **Total Contributors**: 36
+- **Total Contributions**: 326
 - **Major Contributors** (50+ contributions): 0
 - **Regular Contributors** (10-49 contributions): 10
-- **Occasional Contributors** (1-9 contributions): 24
+- **Occasional Contributors** (1-9 contributions): 26
 
-_Last updated: 2025-12-13_
+_Last updated: 2026-01-01_
 
 
 ### Major Contributors
@@ -57,8 +57,8 @@ _10-49 contributions_
 - **[rbrugo](https://github.com/rbrugo)** (44 contributions)
 - **[yasamoka](https://github.com/yasamoka)** (20 contributions)
 - **[hofbi](https://github.com/hofbi)** (19 contributions)
+- **[rothmichaels](https://github.com/rothmichaels)** (19 contributions)
 - **[Twon](https://github.com/Twon)** (17 contributions)
-- **[rothmichaels](https://github.com/rothmichaels)** (17 contributions)
 - **[kwikius](https://github.com/kwikius)** (16 contributions)
 - **[RalphSteinhagen](https://github.com/RalphSteinhagen)** (14 contributions)
 - **[mikeford1](https://github.com/mikeford1)** (13 contributions)
@@ -73,9 +73,11 @@ _Everyone who has contributed to mp-units_
 - **[HazardyKnusperkeks](https://github.com/HazardyKnusperkeks)**
 - **[nebkat](https://github.com/nebkat)**
 - **[jansende](https://github.com/jansende)**
+- **[kammce](https://github.com/kammce)**
 - **[jvocht](https://github.com/jvocht)**
 - **[uilianries](https://github.com/uilianries)**
 - **[sohamroy19](https://github.com/sohamroy19)**
+- **[alejandro-alvarez-sonarsource](https://github.com/alejandro-alvarez-sonarsource)**
 - **[alex-tee](https://github.com/alex-tee)**
 - **[go2sh](https://github.com/go2sh)**
 - **[dkavolis](https://github.com/dkavolis)**

README.md

@@ -72,7 +72,7 @@ dimensional analysis and safe manipulation of units, quantities, and quantity po
 - **Rich Text Formatting** – Text formatting support with extensive options &
   character sets
 - **Flexible Usage** – C++ modules support (when available) and header‑only usage
-- **Configurable** – Contracts, freestanding mode, and natural units (experimental)
+- **Configurable** – Contracts and freestanding mode
 - **Interoperable** – Seamless pathways for legacy and external libraries
 
 ### Quick Example
@@ -117,9 +117,9 @@ analysis at compile time—without sacrificing runtime performance or accuracy.
 Here's a broader preview showcasing **mp-units** capabilities:
 
 ```cpp
-#include <mp-units/systems/international.h>
 #include <mp-units/systems/isq.h>
 #include <mp-units/systems/si.h>
+#include <mp-units/systems/yard_pound.h>
 #include <format>
 #include <iomanip>
 #include <iostream>
@@ -128,15 +128,15 @@ Here's a broader preview showcasing **mp-units** capabilities:
 using namespace mp_units;
 
 constexpr QuantityOf<isq::speed> auto avg_speed(QuantityOf<isq::length> auto d,
-                                                QuantityOf<isq::time> auto t)
+                                                QuantityOf<isq::duration> auto t)
 {
   return d / t;
 }
 
 int main()
 {
   using namespace mp_units::si::unit_symbols;
-  using namespace mp_units::international::unit_symbols;
+  using namespace mp_units::yard_pound::unit_symbols;
 
   constexpr quantity v1 = 110 * km / h;
   constexpr quantity v2 = 70 * mph;
@@ -156,7 +156,7 @@ int main()
 }
 ```
 
-[![Try it live on Compiler Explorer](https://img.shields.io/badge/Try_live_on-Compiler_Explorer-black?style=for-the-badge&logo=compilerexplorer&labelColor=black&color=67C52A)](https://godbolt.org/z/fxcjs19ah)
+[![Try it live on Compiler Explorer](https://img.shields.io/badge/Try_live_on-Compiler_Explorer-black?style=for-the-badge&logo=compilerexplorer&labelColor=black&color=67C52A)](https://godbolt.org/z/rYq7cfdxY)
 
 
 ## 🔍 Try It Out

conanfile.py

@@ -61,7 +61,6 @@ class MPUnitsConan(ConanFile):
         "no_crtp": [True, False],
         "contracts": ["none", "gsl-lite", "ms-gsl"],
         "freestanding": [True, False],
-        "natural_units": [True, False],
     }
     default_options = {
         # "cxx_modules" default set in config_options()
@@ -71,7 +70,6 @@ class MPUnitsConan(ConanFile):
         "import_std": False,  # still experimental in CMake
         "contracts": "gsl-lite",
         "freestanding": False,
-        "natural_units": True,
     }
     implements = ["auto_header_only"]
     exports = "LICENSE.md"
@@ -285,7 +283,6 @@ def generate(self):
             tc.cache_variables["MP_UNITS_API_STD_FORMAT"] = opt.std_format
         tc.cache_variables["MP_UNITS_API_NO_CRTP"] = opt.no_crtp
         tc.cache_variables["MP_UNITS_API_CONTRACTS"] = str(opt.contracts).upper()
-        tc.cache_variables["MP_UNITS_API_NATURAL_UNITS"] = opt.natural_units
 
         tc.generate()
         deps = CMakeDeps(self)
@@ -346,10 +343,6 @@ def package_info(self):
             self.cpp_info.components["core"].defines.append(
                 "MP_UNITS_API_NO_CRTP=" + str(int(self.options.no_crtp == True))
             )
-            self.cpp_info.components["core"].defines.append(
-                "MP_UNITS_API_NATURAL_UNITS="
-                + str(int(self.options.natural_units == True))
-            )
 
             # handle hosted configuration
             if self.options.freestanding:

docs/blog/posts/2.1.0-released.md

@@ -130,7 +130,7 @@ We've also introduced an innovative approach that allows us to specify if such
 conversions should happen implicitly or if they need to be forced explicitly.
 
 More on this subject can be found in the [Interoperability with Other
-Libraries](../../users_guide/use_cases/interoperability_with_other_libraries.md)
+Libraries](../../how_to_guides/interoperability_with_other_libraries.md)
 chapter.
 
 

docs/blog/posts/2.2.0-released.md

@@ -143,7 +143,7 @@ code like the below anymore:
 Additionally, we merged all of the compatibility-related macros into one header
 file `mp-units/compat_macros.h`. This header file should be explicitly included
 before importing C++ modules if we want to benefit from the
-[Wide Compatibility tools](../../users_guide/use_cases/wide_compatibility.md).
+[Wide Compatibility tools](../../how_to_guides/wide_compatibility.md).
 
 
 ## Better control over the library's API