Skip to content

docs: refresh Docker tag guidance + nav release link post-v0.4.0 - #628

Merged
laboef1900 merged 1 commit into
devfrom
chore/docs-post-v0.4-tag-cleanup
May 6, 2026
Merged

docs: refresh Docker tag guidance + nav release link post-v0.4.0#628
laboef1900 merged 1 commit into
devfrom
chore/docs-post-v0.4-tag-cleanup

Conversation

@laboef1900

Copy link
Copy Markdown
Contributor

Summary

Three small documentation refreshes after this morning's v0.5.0-tag retirement and :latest-tag fix:

  1. README nav — replace <a href="docs/releases/v0.3.0.md">v0.3 release notes</a> with <a href="https://github.com/Compendiq/compendiq-ce/releases">Releases</a> so the link is durable across future tags. The v0.3.0 release-notes file isn't being deleted; it just isn't the default header link anymore.
  2. docs/architecture/02-container.md — append a paragraph explaining the three tag classes (:latest, :0.4.0/:0.4, :dev) below the per-container image table, so a reader picking which tag to pin has a meaningful story rather than just an untagged image name.
  3. docs/architecture/05-deployment.md — 2-replica EE compose example now uses :latest instead of :dev (with an inline comment about the alternatives). :dev was the wrong default for a documented production deployment example.

Pairs with Compendiq/compendiq-ee#174 (EE README — Registry Tags + Version Compatibility tables refreshed).

Test plan

  • Local diff inspected: 3 files, +7/−2 lines, all documentation.
  • CI green (no code paths touched, expect Tests/Typecheck/etc. to pass clean).

🤖 Generated with Claude Code

The v0.4.0 release shipped on 2026-04-23 / 2026-05-05 (CE / EE) and the
short-lived v0.5.0 alignment tag was retired 2026-05-06. README and
architecture docs were still pointing at the v0.3 release notes file
and the EE multi-replica deployment example used `:dev` as if it were
the production default — both worth refreshing now that the floating
`:latest` / `:dev` / pinned-semver tag scheme is documented and
mechanically correct (`docker-build.yml` PR #625 / `build-ee.yml`
PR #171 from earlier today).

- README nav: `v0.3 release notes` → `Releases` (links to GitHub
  releases page, durable across future tags).
- `docs/architecture/02-container.md`: append a paragraph explaining
  the three tag classes (`:latest`, `:0.4.0`/`:0.4`, `:dev`) so the
  Image column has a meaningful tag-selection story.
- `docs/architecture/05-deployment.md`: 2-replica compose example now
  uses `:latest` (with a comment about the alternatives) instead of
  `:dev` — `:dev` is the wrong default for a documented production
  deployment example.

No content / behaviour changes. Documentation only.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@laboef1900
laboef1900 merged commit 9bebffa into dev May 6, 2026
5 checks passed
@laboef1900
laboef1900 deleted the chore/docs-post-v0.4-tag-cleanup branch May 21, 2026 17:05
@laboef1900
laboef1900 restored the chore/docs-post-v0.4-tag-cleanup branch May 21, 2026 17:07
@laboef1900
laboef1900 deleted the chore/docs-post-v0.4-tag-cleanup branch May 21, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant