Summary
Review the JSON documentation and examples to ensure they match the final public contracts.
Current behavior
The module contains extensive header documentation, a README, examples, benchmark reports, and a changelog.
Some behavior requires clearer or unified documentation, including:
- Simple ownership and copy semantics;
- integer range behavior;
- JPath mutation behavior;
- file replacement guarantees;
- safe API error suppression;
- ordered versus unordered builders;
- literal macro configuration;
- parsing and serialization limits.
Expected behavior
Users should be able to understand the module’s two JSON models and choose the correct API without reading implementation details.
Scope
Suggested files
modules/json/README.md
modules/json/CHANGELOG.md
modules/json/include/vix/json/*.hpp
modules/json/examples/...
modules/json/benchmarks/README.md
Acceptance criteria
Non-goals
This issue does not include:
- redesigning public APIs;
- translating documentation;
- adding unrelated tutorials;
- performance implementation changes.
Summary
Review the JSON documentation and examples to ensure they match the final public contracts.
Current behavior
The module contains extensive header documentation, a README, examples, benchmark reports, and a changelog.
Some behavior requires clearer or unified documentation, including:
Expected behavior
Users should be able to understand the module’s two JSON models and choose the correct API without reading implementation details.
Scope
Jsonversus Simple.Suggested files
modules/json/README.mdmodules/json/CHANGELOG.mdmodules/json/include/vix/json/*.hppmodules/json/examples/...modules/json/benchmarks/README.mdAcceptance criteria
Non-goals
This issue does not include: