Skip to content

Doc-system changelog

Tracks releases of the documentation portal itself. This is independent of the API changelog at docs/api/changelog.md. Both are versioned but the version numbers do not have to align.

Releases are pinned via annotated git tags (v1.0, v1.1, …) — see README.md. Entries below are append-only.

Conventions

  • [release] — a new minor or major tag (v1.1, v2.0).
  • [patch] — typo / link / clarification on master; no new tag.
  • [backport] — exceptional edit landed at a patch tag (v1.0.1) of a previous minor (see CONTRIBUTING.md → "Backports across tagged releases").

v1.0 — planned [release]

Initial baseline. First tagged release of the Evospin / dropbet documentation portal.

Status: the v1.0 tag has not yet been created. It will be cut once the structural-cleanup pass on master settles. Treat the bullets below as the planned contents of the tag.

Established in v1.0

  • Three-track reading model: business / delivery / engineering. Each track has its own README acting as the entry point and reading order.
  • Cross-cutting reference set: api-reference/, architecture/, security/, handover/, recipes/, runbooks/, data-model/, adr/, flows/, onboarding/.
  • API SOT chain wired end-to-end: live Swagger → api-reference/openapi/*.json → rendered Markdown + Postman collections + API changelog.
  • Architecture: Mermaid service map + sequence diagrams for sign-in and bet-place.
  • E2E trace demo at e2e-trace-demo.md validating the OTel pipeline end-to-end on the local stack.
  • Glossary glossary.md with file:line citations.
  • Style guide STYLE.md.
  • Versioning model on git tags (this changelog + README.md + CONTRIBUTING.md).

Known TBDs at v1.0

  • Performance ramp final numbers — phase 4 of the perf programme is in flight.
  • Some engineering/api.md cross-refs are still being consolidated.

Forward template

When cutting a new release (vX.Y), copy this block into a new dated entry above:

## vX.Y — YYYY-MM-DD [release]

<one-sentence summary>

### Added since v<previous>
- <bulleted list, one fact per bullet>

### Modified since v<previous>
- <bulleted list>

### Removed / renamed since v<previous>
- <bulleted list — note migration impact for external citers>

### Migration
- <if any breaking changes for external citers>

For patches and backports:

## YYYY-MM-DD [patch]
- <one-line summary of fix> (file: docs/<path>)

## YYYY-MM-DD [backport]
- Tag: v<X.Y.Z>
- Reason: <why this exceptional edit>
- Reviewer: <name>