Update documentation and service versions (#1396)#1452
Conversation
- Updates nodejs versions in dockerfiles - Updates npm dependencies of runner and lib microservices Document Capabilities, Concurrent Execution and Settings Improve Github Actions (INTO-CPS-Association#1411) - Adds permissions to all GitHub Actions - Pins all GitHub Actions to specific commit hashes with version tags for security - Adds granular permission scopes at both workflow and job levels - Updates runner NPM publishing to publish at npmjs registry GitHub config dependency upgrades (INTO-CPS-Association#1415) - Fixes GitHub Actions workflows - New agent configuration files in .github/agents/ - Adds npm publish step to runner workflow - Environment variable naming changes in docker/compose.dev.yml Fixes workflow errors and package dependencies (INTO-CPS-Association#1418) - Fixes mistakes in runner.yml workflow - Updates npm packages of libms Add summary table Adds new markdown docs to mkdocs webpage index Adds new markdown docs to mkdocs webpage index Updates docs based on release-v0.7 docs Updates figures in the docs Fix names and file paths in the docs Fix URLs in the docs Fix clone instructions in the docs Adds python script to prepare docs for release Fixes quality issues in python script and mkdocs config [WIP] gitlab integration docs updated Revises documentation Fixes qlty issues in documentation Fixes qlty issues in python script Fixes qlty issues and adds python script to format tables Fixes qlty issues and adds qlty config Adds new developer documentation Adds new admin guide Formats long commands Edits docs into impersonal and academic style Resolve merge conflicts Improves wording in docs Formats tables in docs Fixes description in some docs Adds DevOps docs Updates platform service versions
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to align with the latest codebase and includes updates to software versions in platform services. The changes are part of the release-v0.8 preparation and address issue #1061 while incorporating changes proposed in PR #1421.
Changes:
- Documentation updates across user, admin, and developer guides to improve clarity and consistency
- New documentation files for scripts, tools, and platform features
- Reformatting of markdown tables for consistency
- Updates to copyright years (2024 → 2026)
- Addition of academic references and funding acknowledgments
Reviewed changes
Copilot reviewed 120 out of 220 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| servers/execution/runner/README.md | Table formatting improvements for REST API documentation |
| script/docs/*.py | New Python scripts for documentation content replacement and markdown table formatting |
| mkdocs.yml, mkdocs-github.yml | Navigation structure updates and file path corrections |
| docs/user/website/*.md | New and updated user interface documentation |
| docs/user/servers/lib/*.md | Documentation improvements for library assets and microservice |
| docs/user/examples/*.md | Consistent table formatting and language improvements across examples |
| docs/user/digital-twins/*.md | Updated lifecycle documentation and DevOps feature descriptions |
| docs/third-party.md | Updated third-party software list with consistent formatting |
| docs/thanks.md | Restructured to emphasize funding sources over individual contributors |
| docs/redirect-page.html | Added version 0.7.0 documentation links |
| docs/publish/*.md | New documentation templates for release and clone workflows |
| docs/index.md | Updated overview with current video/slide links |
| docs/developer/*.md | Enhanced developer documentation with architecture details and testing guidelines |
| docs/admin/vagrant/*.md | Improved vagrant deployment documentation |
| deploy/docker/.env.local | Fixed example username format |
Comments suppressed due to low confidence (4)
docs/user/website/index.md:1
- The URL
https://foo.com/config/usershould be replaced with a placeholder that clearly indicates it needs customization (e.g.,https://<your-domain>/config/useror use consistent placeholder formatting throughout the document).
docs/user/motivation.md:1 - The documentation references slides and videos dated June 5, 2025, which is in the future relative to the current date (January 15, 2026 as stated in instructions, but the actual content date is June 2025 which would have been future at time of writing). Verify these resources exist and the dates are correct.
docs/user/examples/mass-spring-damper-monitor/README.md:1 - Corrected spelling of 'derives' to 'derived' and 'te' to 'the'.
docs/user/servers/execution/runner/README.md:1 - Fixed unclosed quote in JSON example from '<command-name"' to ''.
Codecov Report✅ All modified and coverable lines are covered by tests. Please upload reports for the commit 95929ab to get more accurate results. Additional details and impacted files@@ Coverage Diff @@
## feature/distributed-demo #1452 +/- ##
=========================================================
Coverage 96.96% 96.96%
=========================================================
Files 5 5
Lines 264 264
=========================================================
Hits 256 256
Misses 8 8
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 127 out of 225 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (1)
docs/user/servers/execution/runner/readme.md:227
- Corrected syntax error in JSON example from unclosed string to properly closed string.
| return re.compile(pattern, re.MULTILINE) | ||
|
|
||
|
|
||
| def substitute_variables(template: str, version: str, url: str) -> str: |
There was a problem hiding this comment.
The function name substitute_variables and its implementation suggest it only handles VERSION and URL placeholders, but the documentation doesn't clearly specify which variables are supported. Consider adding documentation that explicitly lists the supported placeholder variables (VERSION, URL) to avoid confusion.
| return "|" in line and line.strip().startswith("|") | ||
|
|
||
|
|
||
| def find_tables(content: str) -> list[tuple[int, int]]: |
There was a problem hiding this comment.
The function uses Python 3.9+ syntax for type hints (list[tuple[int, int]] instead of List[Tuple[int, int]]). While this is valid in Python 3.9+, ensure this is documented in project requirements or use from __future__ import annotations for better compatibility if targeting earlier Python versions.
script/docs-requirements.txt
Outdated
| @@ -0,0 +1 @@ | |||
| mistune>=3.0.0 | |||
There was a problem hiding this comment.
This file appears to be a duplicate of script/docs/requirements.txt with identical content. Consider consolidating these files to avoid maintenance overhead and potential inconsistencies.
| [1]: Talasila, Prasad, et al. "Composable digital twins on Digital Twin | ||
| as a Service platform." Simulation 101.3 (2025): 287-311. |
There was a problem hiding this comment.
The citation format uses [1]: which is not standard Markdown footnote syntax. Standard Markdown footnotes should use [^1] for the reference marker. This inconsistency appears in multiple files (assets.md, features.md, motivation.md).
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 130 out of 221 changed files in this pull request and generated 4 comments.
Comments suppressed due to low confidence (1)
servers/execution/runner/README.md:183
- Fixed typo: corrected malformed JSON string by adding missing closing quote.
| the features illustrated in the following diagram. | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
The image reference DTaaS-user-view.png is changed from current-status.png, but it's unclear if this file exists. The PR shows image files being moved to an images/ subdirectory for other pages but not for this file. This may result in a broken image link.
| - Support for heterogeneous Digital Twin implementations | ||
| - CFD, Simulink, co-simulation, FEM, ROM, ML, and other paradigms | ||
| - Integration with existing Digital Twin frameworks | ||
| - Provision of Digital Twin as a Service capabilities[^1] |
There was a problem hiding this comment.
The footnote syntax [^1] is used but the actual footnote reference is defined as [1]: (not [^1]:). This inconsistency will cause the footnote link to be broken. Either use [1] inline or define the footnote as [^1]: in the References section.
| | MQTT | Lightweight data transfer broker for IoT devices and physical twins providing data to digital twins. | | ||
| | MongoDB | NoSQL document database for storing metadata from physical twins. | | ||
| | PostgreSQL | SQL database server for storing historical and time-series data. | | ||
| | ThingsBoard | an Internet of Things (IoT) device management and data visualization platform | |
There was a problem hiding this comment.
Capitalization inconsistency: 'an' should be 'An' to match the sentence case used in other service descriptions.
| user/digital-twins/devops/concurrent-execution.md | ||
| - Gitlab Tutorial: user/gitlab/tutorial.md | ||
| - Runner: user/servers/execution/runner/README.md | ||
| - Runner: user/servers/execution/runner/readme.md |
There was a problem hiding this comment.
The file path uses lowercase readme.md but should verify this matches the actual filename. The diff shows the file as README.md (uppercase) in the original location. This could cause a broken link on case-sensitive filesystems.
|
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 126 out of 217 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
docs/user/servers/execution/runner/readme.md:227
- Corrected malformed JSON closing quote in example response.
| the DTaaS software installation. | ||
| | Service | Advantage | | ||
| | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | InfluxDB | Internet of Things (IoT) device management and data visualization platform. This service stores data for digital twins and provides alerting capabilities. | |
There was a problem hiding this comment.
The description of InfluxDB is inaccurate. InfluxDB is a time-series database, not an IoT device management platform. The description seems to have been confused with ThingsBoard. InfluxDB should be described as "Time-series database primarily for storing time-series data from physical twins with support for visualization dashboards and alerting."
prasadtalasila
merged commit 5e0b11b
into
INTO-CPS-Association:feature/distributed-demo
Pull Request Template
Title
Updates documentation to align with the latest code base and also includes updates to software versions in platform services
Type of Change
Impact
This documentation will be used for release-v0.8.
Additional Information
Addresses issue #1061 and includes changes proposed in PR #1421. Manual testing has been done on the platform services compose file.
Checklist
existing code.