Skip to content

Conversation

cortadocodes
Copy link
Member

@cortadocodes cortadocodes commented Aug 5, 2025

Contents (#738)

IMPORTANT: There is 1 breaking change.

Enhancements

  • Update version compatibility table script for markdown format

Dependencies

  • Add mkdocs-material
  • Add mkdocs-glightbox to provide image zooming to docs
  • Remove dependencies and config from old documentation
  • Add tabulate for version table script

Refactoring

  • 💥 BREAKING CHANGE: Replace octue twined start CLI subcommand with octue twined service start subcommand

Reversions

  • Revert "REF: Remove google_crc32c warning suppression"

Other

  • Convert documentation from restructured text (RST) to markdown (MD)
  • Use mkdocs and Material for Mkdocs to build and theme documentation
  • Document using TWINED_SERVICES_TOPIC_NAME envvar
  • Disable sphinx pre-commit step
  • Update CLI printout in readme
  • Replace "Octue SDK" with "Twined" in docs
  • Move CONTRIBUTING.md to repo root and update it

Upgrade instructions

💥 Replace `octue twined start` CLI subcommand with `octue twined service start` subcommand

Use octue twined service start instead of octue twined start

@cortadocodes cortadocodes self-assigned this Aug 5, 2025
@codecov-commenter
Copy link

codecov-commenter commented Aug 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.05%. Comparing base (19ed977) to head (9e040ad).
⚠️ Report is 36 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #738      +/-   ##
==========================================
- Coverage   94.29%   94.05%   -0.24%     
==========================================
  Files          92       97       +5     
  Lines        3836     3868      +32     
==========================================
+ Hits         3617     3638      +21     
- Misses        219      230      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cortadocodes cortadocodes force-pushed the move-twined-service-start-command branch from 06f84b8 to a43d1c9 Compare August 18, 2025 23:16
@cortadocodes cortadocodes force-pushed the move-twined-service-start-command branch from a43d1c9 to 080be20 Compare August 18, 2025 23:17
@cortadocodes cortadocodes changed the title Move octue twined start CLI command to octue twined service start Improve CLI subcommand organisation and convert docs to Material for Mkdocs Aug 19, 2025
@cortadocodes cortadocodes merged commit 5ef4730 into main Aug 19, 2025
5 checks passed
@cortadocodes cortadocodes deleted the move-twined-service-start-command branch August 19, 2025 21:00
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.

2 participants