Current v1.0.0 plan (2026-07-22)
Starts after: #95. Blocks: #90.
README.md, CHANGELOG.md, CITATION.cff, REFERENCES.md, and the release guidance already exist and are the baseline. Finish and verify the delta against the final implementation, viewer, Python harness, documentation site, compiler/platform matrix, and release gates; do not recreate completed documents or pull implementation work into this issue.
The result is a release-ready documentation and metadata set for the readiness approval in #90.
Native GitHub dependency metadata is the source of truth for ordering.
Summary
Make the final release documentation truthful, reproducible, citable, and explicit about the transition to causal-triangulations.
Scope
- Rewrite the README around the supported 2+1D spherical C++23 release.
- Add a prominent historical and maintenance-status notice.
- Point active users and contributors to https://github.com/acgetchell/causal-triangulations.
- Document the final clean-checkout build and test commands.
- Publish the tested compiler, standard-library, and platform matrix.
- Document scientific limitations, known unsupported features, random-seed behavior, and persistence guarantees.
- Remove claims about C++20, retired services, unused dependencies, unsupported topology, unbuilt programs, and inactive multithreading.
- Update contribution guidance for an imminently archived repository.
- Add CHANGELOG.md and final release notes.
- Add
CITATION.cff with validated authorship, version, license, repository, release date, preferred citation, and DOI or archival identifier metadata.
- Add
REFERENCES.md as the canonical bibliography for the scientific, mathematical, algorithmic, numerical, and research-software foundations implemented or claimed by CDT++.
- Prefer relevant primary sources for CDT, Regge calculus, Pachner/ergodic moves, Metropolis-Hastings, Delaunay triangulation, CGAL algorithms, robust/exact arithmetic, and RNG methodology; retain secondary sources when they provide necessary context.
- Add local pointers from the README, active design documentation, and implementation-facing documentation to the relevant
REFERENCES.md entries so credit is discoverable where methods are described or used.
- Validate DOI and source links mechanically and verify that resolved title, authors, venue, year, and relevance match each bibliography entry.
- Add an archival SECURITY.md or support statement that explains where new reports should go.
- Synchronize v1.0.0 across CMake, vcpkg, CLI version output, Doxygen, citation metadata, and release documentation.
- Ensure generated API documentation has a reproducible command and no release-blocking warnings.
Acceptance criteria
- Every documented command and support claim is verified against source or CI.
- Version, date, license, repository, and successor metadata agree.
CITATION.cff passes schema validation and agrees with the v1.0.0 release and archival metadata.
REFERENCES.md exists, is linked from the README, covers every material scientific or algorithmic claim in the supported reference-oracle scope, and contains no known dead, malformed, metadata-mismatched, irrelevant, or unexplained orphan references.
- Active documentation and implementation-facing provenance point to the canonical bibliography without duplicating conflicting citation metadata.
- The archive status and maintenance boundary are unmistakable.
- Local and external documentation links are valid.
- Release notes summarize removals, corrections, compatibility, limitations, and migration to causal-triangulations.
- Documentation checks pass.
Current v1.0.0 plan (2026-07-22)
Starts after: #95. Blocks: #90.
README.md, CHANGELOG.md, CITATION.cff, REFERENCES.md, and the release guidance already exist and are the baseline. Finish and verify the delta against the final implementation, viewer, Python harness, documentation site, compiler/platform matrix, and release gates; do not recreate completed documents or pull implementation work into this issue.
The result is a release-ready documentation and metadata set for the readiness approval in #90.
Summary
Make the final release documentation truthful, reproducible, citable, and explicit about the transition to causal-triangulations.
Scope
CITATION.cffwith validated authorship, version, license, repository, release date, preferred citation, and DOI or archival identifier metadata.REFERENCES.mdas the canonical bibliography for the scientific, mathematical, algorithmic, numerical, and research-software foundations implemented or claimed by CDT++.REFERENCES.mdentries so credit is discoverable where methods are described or used.Acceptance criteria
CITATION.cffpasses schema validation and agrees with the v1.0.0 release and archival metadata.REFERENCES.mdexists, is linked from the README, covers every material scientific or algorithmic claim in the supported reference-oracle scope, and contains no known dead, malformed, metadata-mismatched, irrelevant, or unexplained orphan references.