Niels Lohmann
526b6d3fd6
A review of all documentation pages found factual errors, dead links, missing cross-references, and gaps in examples. This fixes them and adds checks so the same problems are caught automatically. Fixes: - wrong signatures and version histories (operator!= C++20 member, binary() subtype type, get<PointerType>(), JSON_NO_THREAD_LOCAL, ...) - stale descriptions (number parsing since #5283, UBJSON table, SAX example that no longer compiled, tsl::ordered_map advice) - dead internal and external links; repology.org badges (the domain is suspended) replaced by badges that query the registries directly - deprecation notes link the migration guide; the guide itself fixed Additions: - "See also" sections, cross-references, 25 runnable examples, 12 Mermaid diagrams, new API pages for json_pointer::operator<=> and byte_container_with_subtype::operator==/!= - landing page, guides for untrusted input and performance - "unreleased" badge after versions newer than the latest release Checks: - strict documentation build (broken links/anchors fail it); CI and the publish workflow fetch the full history the build needs - weekly external link check, Mermaid syntax check in CI - check_structure.py: example titles, heading levels, alt texts, header links, docset index coverage; its unused-example check works again - all examples produce the same output on every platform Signed-off-by: Niels Lohmann <mail@nlohmann.me>
59 lines
1.2 KiB
YAML
59 lines
1.2 KiB
YAML
version: 2
|
|
updates:
|
|
- package-ecosystem: github-actions
|
|
directory: /
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|
|
groups:
|
|
codeql-action:
|
|
patterns:
|
|
- "github/codeql-action/*"
|
|
|
|
- package-ecosystem: pip
|
|
directory: /docs/mkdocs
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|
|
|
|
- package-ecosystem: npm
|
|
directory: /docs/mkdocs/scripts/mermaid
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|
|
ignore:
|
|
# Material for MkDocs loads mermaid@11; keep the checker on the same major version
|
|
- dependency-name: mermaid
|
|
update-types: ["version-update:semver-major"]
|
|
|
|
- package-ecosystem: pip
|
|
directory: /tools/astyle
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|
|
|
|
- package-ecosystem: pip
|
|
directory: /tools/generate_natvis
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|
|
|
|
- package-ecosystem: pip
|
|
directory: /tools/serve_header
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|
|
|
|
- package-ecosystem: pip
|
|
directory: /cmake/requirements
|
|
schedule:
|
|
interval: daily
|
|
cooldown:
|
|
default-days: 7
|