Skip to content

Improve CLI and rewrite documentation - #739

Merged
cortadocodes merged 119 commits into
mainfrom
rewrite-docs
Nov 10, 2025
Merged

Improve CLI and rewrite documentation#739
cortadocodes merged 119 commits into
mainfrom
rewrite-docs

Conversation

@cortadocodes

@cortadocodes cortadocodes commented Sep 23, 2025

Copy link
Copy Markdown
Collaborator

Contents (#739)

IMPORTANT: There are 4 breaking changes.

Enhancements

  • 💥 BREAKING CHANGE: Run local example service (Fibonacci calculator) if example is used as the service namespace in Child.ask
  • 💥 BREAKING CHANGE: Raise error if example is used as the service namespace in service configurations
  • Add Fibonacci sequence example function

Fixes

  • Update log message advising use of octue twined question command

Refactoring

  • 💥 BREAKING CHANGE: Remove --logger-uri option from CLI
  • 💥 BREAKING CHANGE: Un-nest CLI commands for asking questions
  • Factor out template setting as a class

Chores

  • Remove check-yaml pre-commit check

Documentation

  • Overhaul docs layout
  • Add getting started guides for using services, creating services, and managing infrastructure for services
  • Move most old docs into core concepts section
  • Consolidate old twined repo docs
  • Add troubleshooting infrastructure page
  • Add glossary
  • Use new URL for docs
  • Update CLI help text
  • Simplify installation instructions
  • Enable code snippet copy buttons
  • Adjust wording and style on licence and version history pages
  • Add support page
  • Improve authentication instructions

Upgrade instructions

💥 Run local example service (Fibonacci calculator) if `example` is used as the service namespace in service configurations

Stop using example as a service namespace unless you want to trigger the local example service.

💥 Raise error if example is used as the service namespace in service configurations

Stop using "example" as a service namespace in the service configuration class or octue.yaml file.

💥 Un-nest CLI commands for asking questions

Use:

  • octue twined question ask instead of octue twined question ask remote
  • octue twined question ask-local instead of octue twined question ask local
💥 Remove `--logger-uri` option from CLI

Stop providing the --logger-uri option to the CLI

@cortadocodes cortadocodes self-assigned this Sep 26, 2025
@cortadocodes
cortadocodes marked this pull request as ready for review November 6, 2025 18:08
@cortadocodes cortadocodes changed the title Rewrite documentation Improve CLI and rewrite documentation Nov 10, 2025
@cortadocodes
cortadocodes merged commit ca9c922 into main Nov 10, 2025
6 checks passed
@cortadocodes
cortadocodes deleted the rewrite-docs branch November 10, 2025 21:37
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