From b825d3dafb6030d6b5b3e90b935b8a0c487dfb62 Mon Sep 17 00:00:00 2001 From: Aditya Date: Wed, 3 Dec 2025 04:45:27 +0530 Subject: [PATCH] docs: improve clarity and formatting in documentation generation section (#5021) --- docs/README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index b39d54e05..7cca7f12f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,12 +2,12 @@ ## Generate documentation -Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me. This URL -contains the most recent documentation and should also be applicable to previous versions; documentation for deprecated -functions is not removed, but marked deprecated. +Note on documentation: The source files contain links to the online documentation at https://json.nlohmann.me. +This URL provides the most recent documentation and also applies to previous versions. Documentation for deprecated +functions is not removed; instead, it is marked as deprecated. -If you want to see the documentation for a specific tag or commit hash, you can generate it as follows (here for tag -`v3.10.2`): +If you want to view the documentation for a specific tag or commit hash, you can generate it locally as follows (example +using tag `v3.10.2`): ```shell git clone https://github.com/nlohmann/json.git @@ -16,5 +16,8 @@ git checkout v3.10.2 make install_venv serve -C docs/mkdocs ``` -Open URL in your browser. Replace from any URL from the source code `https://json.nlohmann.me` -with `http://127.0.0.1:8000` to see the documentation for your tag or commit hash. +Open in your browser. Replace any URL in the source code that points to +`https://json.nlohmann.me` with `http://127.0.0.1:8000` to view the documentation for the selected tag or commit hash. + + +