Skip to content

docs: Update for semantic versioning [doc-updater] - #499

Closed
james-in-a-box[bot] wants to merge 1 commit into
mainfrom
egg/doc-update-versioning-docs
Closed

docs: Update for semantic versioning [doc-updater]#499
james-in-a-box[bot] wants to merge 1 commit into
mainfrom
egg/doc-update-versioning-docs

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

Update documentation to reflect changes from e2ae502 (Re-land semantic versioning with review fixes #487).

Changes

docs/development/STRUCTURE.md

  • Added create-release.sh to the GitHub Workflows Scripts section

docs/guides/deployment.md

  • Expanded Pre-built Images section to document semantic version tags (latest, v0, v0.1, v0.1.0)
  • Added explanation of version tag hierarchy and use cases
  • Documented pre-release version tag behavior
  • Added reference to RELEASING.md

docs/index.md

  • Added RELEASING.md to the Development section of the documentation index

Rationale

The semantic versioning commit introduced:

  1. A new .github/scripts/create-release.sh script for creating releases
  2. Floating tag support in the release workflow (v0, v0.1, etc.)
  3. Comprehensive RELEASING.md documentation

These documentation updates ensure the new infrastructure is discoverable through the project structure docs, deployment guides reference the version tagging scheme, and the release documentation is linked from the index.

Triggered by: e2ae502

Authored-by: egg

Update documentation to reflect changes from e2ae502:
- Add create-release.sh to STRUCTURE.md workflow scripts section
- Expand deployment.md to document semantic version tags (v0, v0.1, v0.1.0)
- Add RELEASING.md to index.md development section

The commit introduced a comprehensive semantic versioning system with a
release script and floating tag support. These docs ensure the new release
process and version pinning options are discoverable.

Authored-by: egg

@james-in-a-box james-in-a-box Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

This is a documentation-only PR that updates three files to reflect changes from the semantic versioning commit (e2ae502). I've reviewed all changes systematically.

Files Reviewed

docs/development/STRUCTURE.md

  • Adds create-release.sh to the GitHub Workflows Scripts section
  • Entry is correctly positioned alphabetically (after checks/, before push-contract-update.sh)
  • File exists and is executable at .github/scripts/create-release.sh
  • Description accurately reflects the script's purpose

docs/guides/deployment.md

  • Removes :latest from image table (appropriate since tags are now documented separately)
  • Adds comprehensive Version Tags section explaining the tag hierarchy
  • Examples are clear and accurate (v0, v0.1, v0.1.0, latest)
  • Pre-release behavior is correctly documented (exact tag only, no floating tags)
  • Enhanced .env examples with comments and major version pinning option
  • Link to RELEASING.md uses correct relative path (../../RELEASING.md resolves correctly from docs/guides/)

docs/index.md

  • Adds RELEASING.md to the Development section
  • Placement is appropriate (after Contributing.md, as releasing logically follows development workflow)
  • Link uses correct relative path (../RELEASING.md resolves correctly from docs/)

Verification Performed

  • Confirmed create-release.sh exists at the documented location
  • Confirmed the referenced commit (e2ae502) exists with expected message
  • Verified all relative links resolve to valid files
  • Confirmed documentation is consistent with RELEASING.md content

No issues found. Documentation changes accurately reflect the semantic versioning infrastructure.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author
egg is addressing review feedback...

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

1 previous review(s) hidden.

@jwbron jwbron closed this Feb 10, 2026
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