From 187e9d22edb442a008058805bc7ee49ec8097714 Mon Sep 17 00:00:00 2001 From: Ayinkx <199975741+Ayinkx@users.noreply.github.com> Date: Wed, 28 Oct 2026 18:06:16 +0100 Subject: [PATCH] docs: clean up the 0.1.0 changelog and counts Merge the duplicated Changed sections, move the security entry under Security, record the release and demo docs, and update the open-issue count to 122. --- CHANGELOG.md | 63 ++++++++++++++++++----------------------- docs/DRIPS_READINESS.md | 2 +- docs/FINAL_AUDIT.md | 2 +- docs/ISSUE_BACKLOG.md | 2 +- 4 files changed, 31 insertions(+), 38 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 99899c8..8d5aeb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,40 +13,11 @@ First tagged release. Linux x86_64, macOS arm64, and Windows x86_64 archives with SHA256 checksums are attached to the GitHub Release. crates.io publication is still pending. -### Changed - -- Build: raised the workspace MSRV from 1.85 to 1.88 to match the - `stellar-xdr 28` → `serde_with` → `darling` toolchain requirement, and updated - the MSRV CI job. -- Security: replaced the unmaintained `serde_yml` dependency with - `serde_yaml_ng`, removing `noyalib` and resolving RUSTSEC-2026-0333. -- Documentation: point repository, installation, and Wave links at - `AyinkxLab/stellar-contract-platform`. - -### Documentation - -- Installation: document the working `cargo install --git` path (package - `observatory-cli`, binary `stellar-contract-platform`) and state explicitly - that no crates.io package or prebuilt binary exists yet. See - `docs/installation.md`. -### Security - -- Replace the unsound, unmaintained `serde_yml` parser (which pulled in - `noyalib` 0.0.5, RUSTSEC-2026-0333) with the maintained `serde_yaml_ng` - fork. YAML project configuration parsing is unchanged. - -### Changed - -- Raise the workspace MSRV from 1.85 to 1.88 so the locked dependency set - (`wasmparser` 0.259, `stellar-strkey` 0.0.18, `serde_with` 3.23) resolves and - the MSRV CI job matches the workspace `rust-version`. - ### Added - CI: report test coverage with `cargo-llvm-cov` on pull requests. The job writes a summary to the workflow run, uploads an `lcov.info` artifact, and - keeps the coverage floor advisory (`continue-on-error`). See - `docs/testing.md`. + keeps the coverage floor advisory (`continue-on-error`). See `docs/testing.md`. - Events: accept raw base64 `ContractEvent` XDR, either as a bare input or an `xdr` field on a fixture entry, and normalize it to the existing `EventRecord` shape. See `docs/events.md`. @@ -98,14 +69,36 @@ is still pending. - `observatory-cli`: `inspect`, `spec`, `events`, `diff`, `compat`, `fingerprint`, `deployment`, `verify`, and `doctor`, all with `--json`. - CI: format, clippy, and tests on Linux, Windows, and macOS. - -### Notes - -- No live HTTP RPC transport is shipped yet. Deployment and verification run against deterministic RPC fixtures. -- The audit crate is not a security auditor. +- Release: tag-driven Linux/macOS/Windows binaries with SHA256 checksums. +- Documentation: `docs/WHY_OBSERVATORY.md`, `docs/APPEAL.md`, and an offline + `demo/` with deterministic old/new WASM fixtures. ### Changed +- Build: raised the workspace MSRV from 1.85 to 1.88 so the locked dependency set + (`wasmparser` 0.259, `stellar-strkey` 0.0.18, `serde_with` 3.23) resolves and + the MSRV CI job matches the workspace `rust-version`. - The repository was renamed to `stellar-contract-platform`. The CLI binary (`stellar-contract-platform`), the `observatory-*` crates, and the product name remain unchanged; only the repository URL and clone instructions changed. +- Documentation: repository, installation, and Wave links now use + `AyinkxLab/stellar-contract-platform`. + +### Security + +- Replaced the unsound, unmaintained `serde_yml` parser (which pulled in + `noyalib` 0.0.5, RUSTSEC-2026-0333) with the maintained `serde_yaml_ng` + fork. YAML project configuration parsing is unchanged. + +### Documentation + +- Installation: document the prebuilt archives and the working + `cargo install --git` path (package `observatory-cli`, binary + `stellar-contract-platform`). See `docs/installation.md`. +- Project status, final audit, issue backlog, and Wave board now match `main`. + +### Notes + +- No live HTTP RPC transport is shipped yet. Deployment and verification run + against deterministic RPC fixtures. +- The audit crate is not a security auditor. diff --git a/docs/DRIPS_READINESS.md b/docs/DRIPS_READINESS.md index f3cc993..8d508ce 100644 --- a/docs/DRIPS_READINESS.md +++ b/docs/DRIPS_READINESS.md @@ -21,7 +21,7 @@ identity. It includes a CLI and an API/platform layer. - **Release:** `v0.1.0` is published with Linux x86_64, macOS arm64, and Windows x86_64 archives plus SHA256 checksums: . -- **Backlog:** 123 open issues; the curated [Wave board](WAVE_BOARD.md) has 20 +- **Backlog:** 122 open issues; the curated [Wave board](WAVE_BOARD.md) has 20 open, independent, unimplemented issues (2,700 points). - **Docs:** repository, install, and Wave links use `AyinkxLab/...`; completed issues #9, #102, and #112 are closed and removed from the board. diff --git a/docs/FINAL_AUDIT.md b/docs/FINAL_AUDIT.md index f4d55fa..da8906e 100644 --- a/docs/FINAL_AUDIT.md +++ b/docs/FINAL_AUDIT.md @@ -96,7 +96,7 @@ ISSUE_BACKLOG, FINAL_AUDIT. ## Contributor backlog -123 open issues, each with Context, Problem, Objective, Scope, Acceptance +122 open issues, each with Context, Problem, Objective, Scope, Acceptance criteria, Testing, Relevant modules/files, Implementation guidance, an example commit message, and guidelines. Dependencies are explicit. No aggregate point or reward figures are published anywhere, and an automated audit found zero diff --git a/docs/ISSUE_BACKLOG.md b/docs/ISSUE_BACKLOG.md index 4737183..9061bfa 100644 --- a/docs/ISSUE_BACKLOG.md +++ b/docs/ISSUE_BACKLOG.md @@ -4,7 +4,7 @@ This document summarizes the issue backlog by phase. It is a map, not a contract. Every issue is real engineering work derived from the current architecture; there are no placeholder or filler issues. -As of 2026-10-28 the repository contains **123 open issues**. Issues #9, #102, +As of 2026-10-28 the repository contains **122 open issues**. Issues #9, #102, and #112 were closed as completed after this snapshot; check GitHub for the current list and the curated [WAVE_BOARD.md](WAVE_BOARD.md).