Add aggregate docs check (#3527)

* Add aggregate docs check

* style: auto-fix by pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: koxudaxi

.github/workflows/llms-txt.yaml

@@ -1,34 +1,46 @@
-name: Update llms.txt
+name: Docs Check All
 
 on:
   pull_request:
     branches: [main]
     paths:
+      - '.github/workflows/llms-txt.yaml'
+      - '.github/workflows/playground-lint.yaml'
+      - 'README.md'
+      - 'docs/**'
+      - 'pyproject.toml'
+      - 'scripts/build_architecture_docs.py'
       - 'src/datamodel_code_generator/**'
-      - 'tests/main/**'
-      - 'tests/data/jsonschema/tutorial_pet.json'
-      - 'tests/test_main_kr.py'
       - 'scripts/build_cli_docs.py'
-      - 'scripts/build_prompt_data.py'
+      - 'scripts/build_conformance_docs.py'
+      - 'scripts/build_deprecation_docs.py'
+      - 'scripts/build_diagrams.py'
+      - 'scripts/build_docs_examples.py'
+      - 'scripts/build_experimental_docs.py'
+      - 'scripts/build_release_benchmark_docs.py'
+      - 'scripts/build_llms_txt.py'
+      - 'scripts/build_playground_assets.py'
       - 'scripts/build_preset_docs.py'
-      - 'src/datamodel_code_generator/parser/schema_version.py'
+      - 'scripts/build_prompt_data.py'
       - 'scripts/build_schema_docs.py'
-      - 'scripts/build_release_benchmark_docs.py'
-      - 'docs/data/release-benchmarks.json'
-      - 'docs/data/release-benchmark-notes.json'
-      - 'docs/assets/benchmarks/release-benchmarks.css'
-      - 'docs/assets/benchmarks/release-benchmarks.js'
-      - 'docs/**/*.md'
-      - 'README.md'
+      - 'scripts/update_command_help_on_markdown.py'
+      - 'scripts/update_generate_prompt_snapshots.py'
+      - 'tests/data/expected/main/jsonschema/**'
+      - 'tests/data/expected/main/openapi/**'
+      - 'tests/data/jsonschema/**'
+      - 'tests/data/openapi/**'
+      - 'tests/main/**'
+      - 'tests/test_main_kr.py'
+      - 'tox.ini'
+      - 'uv.lock'
       - 'zensical.toml'
-      - 'scripts/build_llms_txt.py'
 
 permissions:
   contents: read
 
 jobs:
-  update-llms-txt:
-    runs-on: ubuntu-latest
+  docs-check-all:
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
@@ -38,41 +50,18 @@ jobs:
           persist-credentials: false
       - name: Install the latest version of uv
         uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
-      - name: Install tox
-        run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
-      - name: Setup README environment
-        run: tox run -vv --notest --skip-missing-interpreters false -e readme
-        env:
-          UV_PYTHON_PREFERENCE: "only-managed"
-      - name: Setup CLI docs environment
-        run: tox run -vv --notest --skip-missing-interpreters false -e cli-docs
-        env:
-          UV_PYTHON_PREFERENCE: "only-managed"
-      - name: Setup schema docs environment
-        run: tox run -vv --notest --skip-missing-interpreters false -e schema-docs
+        with:
+          enable-cache: true
+          cache-suffix: docs-check-all
+      - name: Setup Python
+        run: uv python install 3.14
         env:
           UV_PYTHON_PREFERENCE: "only-managed"
-      - name: Setup preset docs environment
-        run: tox run -vv --notest --skip-missing-interpreters false -e preset-docs
+      - name: Install tox
+        run: uv tool install --python-preference only-managed --python 3.14 tox --with tox-uv
         env:
           UV_PYTHON_PREFERENCE: "only-managed"
-      - name: Setup llms.txt environment
-        run: tox run -vv --notest --skip-missing-interpreters false -e llms-txt
+      - name: Run aggregate docs check
+        run: tox run -e docs-check-all -- --check
         env:
           UV_PYTHON_PREFERENCE: "only-managed"
-      - name: Update README
-        run: .tox/readme/bin/python scripts/update_command_help_on_markdown.py
-      - name: Collect CLI doc metadata
-        run: .tox/cli-docs/bin/pytest tests --collect-cli-docs -p no:xdist -q
-      - name: Build CLI docs
-        run: .tox/cli-docs/bin/python scripts/build_cli_docs.py
-      - name: Build prompt data
-        run: .tox/cli-docs/bin/python scripts/build_prompt_data.py
-      - name: Build schema docs
-        run: .tox/schema-docs/bin/python scripts/build_schema_docs.py
-      - name: Build preset docs
-        run: .tox/preset-docs/bin/python scripts/build_preset_docs.py
-      - name: Build release benchmark docs
-        run: .tox/llms-txt/bin/python scripts/build_release_benchmark_docs.py
-      - name: Build llms.txt
-        run: .tox/llms-txt/bin/python scripts/build_llms_txt.py

docs/development-contributing.md

@@ -42,13 +42,10 @@ $ tox run -e 3.13
 ## 8. Format and lint code (will print errors that cannot be automatically fixed)
 $ tox run -e fix
 
-## 9. Check README help text is up to date
-$ tox run -e readme
+## 9. Check generated docs, diagrams, and playground assets are up to date
+$ tox run -e docs-check-all -- --check
 
-## 10. Check CLI documentation is up to date
-$ tox run -e cli-docs
-
-## 11. Commit and Push...
+## 10. Commit and Push...
 ```
 
 ## 🧪 E2E test assertions
@@ -179,16 +176,16 @@ CLI_OPTION_META: dict[str, CLIOptionMeta] = {
 $ pytest --collect-cli-docs -p no:xdist -q
 $ python scripts/build_cli_docs.py
 
-# Verify docs are correct
-$ tox run -e cli-docs
+# Verify generated docs are correct
+$ tox run -e docs-check-all -- --check
 
 # If you modified config.py, regenerate config TypedDicts
 $ tox run -e config-types
 ```
 
 ### 🔧 Troubleshooting
 
-If `tox run -e cli-docs` fails:
+If the `tox run -e docs-check-all -- --check` CLI docs step fails:
 
 - **"No test found documenting option --xxx"**: Add `@pytest.mark.cli_doc(options=["--xxx"], ...)` to a test
 - **"File not found: ..."**: Check that `input_schema` and `golden_output` paths are correct

docs/llms-full.txt

@@ -37534,13 +37534,10 @@ $ tox run -e 3.13
 ## 8. Format and lint code (will print errors that cannot be automatically fixed)
 $ tox run -e fix
 
-## 9. Check README help text is up to date
-$ tox run -e readme
+## 9. Check generated docs, diagrams, and playground assets are up to date
+$ tox run -e docs-check-all -- --check
 
-## 10. Check CLI documentation is up to date
-$ tox run -e cli-docs
-
-## 11. Commit and Push...
+## 10. Commit and Push...
 ```
 
 ## 🧪 E2E test assertions
@@ -37671,16 +37668,16 @@ CLI_OPTION_META: dict[str, CLIOptionMeta] = {
 $ pytest --collect-cli-docs -p no:xdist -q
 $ python scripts/build_cli_docs.py
 
-# Verify docs are correct
-$ tox run -e cli-docs
+# Verify generated docs are correct
+$ tox run -e docs-check-all -- --check
 
 # If you modified config.py, regenerate config TypedDicts
 $ tox run -e config-types
 ```
 
 ### 🔧 Troubleshooting
 
-If `tox run -e cli-docs` fails:
+If the `tox run -e docs-check-all -- --check` CLI docs step fails:
 
 - **"No test found documenting option --xxx"**: Add `@pytest.mark.cli_doc(options=["--xxx"], ...)` to a test
 - **"File not found: ..."**: Check that `input_schema` and `golden_output` paths are correct

tox.ini

@@ -242,6 +242,51 @@ commands =
       -q
 dependency_groups = test
 
+[testenv:generated-docs-check]
+description = Validate generated documentation and prompt snapshots without modifying files
+base_python = python3.14
+set_env =
+    {[testenv]set_env}
+    PYTHONPATH = {tox_root}{/}src
+commands =
+    python scripts/update_command_help_on_markdown.py {posargs:--check}
+    pytest tests --collect-cli-docs -p no:xdist -q
+    python scripts/build_cli_docs.py {posargs:--check}
+    python scripts/build_prompt_data.py {posargs:--check}
+    python scripts/update_generate_prompt_snapshots.py {posargs:--check}
+    python scripts/build_preset_docs.py {posargs:--check}
+    python scripts/build_schema_docs.py {posargs:--check}
+    python scripts/build_docs_examples.py {posargs:--check}
+    python scripts/build_deprecation_docs.py {posargs:--check}
+    python scripts/build_experimental_docs.py {posargs:--check}
+    python scripts/build_conformance_docs.py {posargs:--check}
+    python scripts/build_architecture_docs.py {posargs:--check}
+    python scripts/build_release_benchmark_docs.py {posargs:--check}
+    python scripts/build_llms_txt.py {posargs:--check}
+    pytest \
+      tests/test_main_kr.py::test_generate_prompt_basic \
+      tests/test_main_kr.py::test_generate_prompt_with_question \
+      tests/test_main_kr.py::test_generate_prompt_with_options \
+      tests/test_main_kr.py::test_generate_prompt_with_list_options \
+      -p no:xdist \
+      -q
+dependency_groups = test
+
+[testenv:docs-check-all]
+description = Validate generated docs, rendered diagrams, and playground asset lint
+base_python = {[testenv:generated-docs-check]base_python}
+set_env =
+    {[testenv:generated-docs-check]set_env}
+commands =
+    {[testenv:generated-docs-check]commands}
+    python scripts/build_diagrams.py {posargs:--check}
+    python scripts/build_playground_assets.py
+    t-linter check --error-on-issues docs/assets/playground/app.py
+    t-linter format --check docs/assets/playground/app.py
+dependency_groups =
+    test
+    playground
+
 [testenv:config-types]
 description = Generate TypedDict files from config models (use --check to validate only)
 commands =