mirror of
https://github.com/nlohmann/json.git
synced 2026-10-02 22:14:14 +07:00
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>
11 lines
237 B
JSON
11 lines
237 B
JSON
{
|
|
"name": "check-mermaid",
|
|
"private": true,
|
|
"description": "Validate the Mermaid diagrams of the documentation (see check_mermaid.mjs)",
|
|
"type": "module",
|
|
"dependencies": {
|
|
"jsdom": "30.1.1",
|
|
"mermaid": "11.17.2"
|
|
}
|
|
}
|