Skip to content

docs: remove and update outdated content since v1.2.1 - #40

Draft
csm-memeryroch with Copilot wants to merge 3 commits into
mainfrom
copilot/update-documentation-since-121
Draft

docs: remove and update outdated content since v1.2.1#40
csm-memeryroch with Copilot wants to merge 3 commits into
mainfrom
copilot/update-documentation-since-121

Conversation

Copilot AI commented Jul 31, 2026

Copy link
Copy Markdown

Documentation accumulated stale content referencing tools and commands removed or deprecated between v1.2.1 and v2.1.0. This cleans up those references and adds a CHANGELOG covering all releases in that range.

Removed

  • CosmoTech-Acceleration-Library / csm-data — removed as a hard dependency in v1.3.0. Deleted the entire "Connect to the API" tutorial section in advanced_cosmotech_simulator.md and all csm-data api scenariorun-load-data references.
  • csm-orc run-step — deprecated in v1.5.2, no longer in the CLI. Replaced all invocations with csm-simulator -i $CSM_SIMULATION in both docs and tutorial JSON files.

Updated

  • tutorial/cosmotech_simulator/run.json and tutorial/advanced_cosmotech_simulator/run.json: SimulationRun step now calls csm-simulator directly; DownloadScenarioData step removed entirely.
  • --gen-env-target example output trimmed to match the simplified run.json (API credential vars no longer appear).
  • --skip-step example no longer references the deleted DownloadScenarioData step.

Added

  • CHANGELOG.md + docs/changelog.md: full release history from v1.2.2 → v2.1.0, covering CoAL removal, exit handlers, get_logger migration, translation system, step data transfer, visual orchestrator, and CSM_RUN_TYPE support.
  • docs/tutorial/exit_handlers.md: documented --no-exit-handlers / CSM_ORCHESTRATOR_USE_EXIT_HANDLERS (added v1.5.0, previously undocumented).
  • docs/tutorial/advanced_cosmotech_simulator.md: documented CSM_RUN_TYPE env var and its effect on which JSON template file the entrypoint executes.
  • docs/tutorial/plugins_and_templates.md: noted subfolder lookup in templates/ (added v1.4.3), including on_exit/ layout.
  • mkdocs.yml: Changelog added to Home nav.

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