Skip to content

chore(docs): name the project OpenSysML MDK - #1324

Merged
HuiJun merged 4 commits into
developfrom
chore/mdk-brand-name
Oct 21, 2026
Merged

HuiJun merged 4 commits into
developfrom
chore/mdk-brand-name

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

What and why

The project is named OpenSysML MDK, the second generation of OpenMBEE's Model Development Kit. The one-line description stays "Runtime Environment and Development Kit"; only the "REDK" acronym and the display names derived from it change, in README.md, CONTRIBUTING.md, AGENTS.md, mkdocs.yml (site_name), the landing page (overrides/home.html), docs/README.md, docs/documentation.md, docs/community.md and docs/reference/wasm.md. The README title drops its "(MDK2)" subtitle; the sentence explaining that this is the second generation of OpenMBEE's MDK stays.

Unchanged, because they are identifiers rather than the brand: the repository Open-MBEE/OpenSysML, the Go module path github.com/Open-MBEE/OpenSysML, every package and registry name (opensysml, @openmbee/opensysml*, org.openmbee:opensysml*, crate opensysml, jupyter-opensysml-kernel, org.opensysml/sysml-mcp), binary and release-asset names, OPENSYSML_* environment variables, the domains opensysml.org / runtime.opensysml.org, file and directory names, the MSI UpgradeCode, site_description, the logos (OpenSysML wordmark only), and the product name "OpenSysML" wherever it stands alone. No Go source, manifest (action.yml, MSI, winget, Homebrew, Conda, MCP server.json, VS Code package.json), client README or agent skill said "REDK"; none is touched.

RE/DK build names. The two sysml builds (-tags sysml_re, make build-re, bin/re/sysml) keep their names: they derive from the description, not the acronym. docs/reference/wasm.md and the unreleased fragment changes/unreleased/re-dk-build-names.changed.md now say they are "named after the two halves of the Runtime Environment and Development Kit"; nothing else in that fragment changes.

editors/mdk: OpenSysML MDK for Cameo. The Cameo Systems Modeler plugin was itself named "OpenSysML MDK"; with the product carrying that name, its display name becomes OpenSysML MDK for Cameo everywhere a human reads it: the README heading and first paragraph (which now distinguishes the kit from the plugin), the Maven <name> of the five modules, the name attribute of MDR_Plugin_OpenSysML_MDK_descriptor.xml and of the descriptor PluginDescriptorWriter generates, the dialog and session titles in OperationActions and DocGenExtensions, the Javadoc and error messages in PluginLocator and BridgeResult, the pr.yml job name, and the headings and prose of docs/internals/design/mdk-plugin.md, docs/project/mdk-parity.md, docs/internals/design/README.md and editors/README.md. Unchanged: Maven groupId/artifactId (org.openmbee:opensysml-mdk-*), the Java package org.openmbee.opensysml.mdk, PluginLocator.PLUGIN_ID, the descriptor file name, directory names, and the OpenSysML MDK DocGen profile name that DocGenExtensions.PROFILE_NAME writes into users' models.

CHANGELOG.md and docs/project/archive/CHANGELOG-0.0-0.8.md are not edited (git diff origin/develop -- CHANGELOG.md docs/project/archive/ is empty); the change is recorded in changes/unreleased/mdk-brand-name.changed.md. After this change git grep -w REDK outside those two files matches only that fragment's sentence about the former name.

Satellites: Open-MBEE/OpenSysML-REDK-Skills is being renamed to Open-MBEE/OpenSysML-MDK-Skills separately (this tree does not reference that slug); Open-MBEE/opensysml.github.io says "OpenSysML REDK" in its index.html and gets its own PR there.

How it was verified

All on this branch at its head, Linux, Go 1.25, Node 24, Maven 3.9.9 / JDK 17:

  • gofmt -l . empty; go build ./... and go vet ./... clean.
  • go test -count=1 ./... with the training corpus, pilot corpora, pilot library XMI and PSSM suite fetched: pass (includes ./tests/hygiene/..., ./tests/wasm/..., ./internal/frontend/...; no fixture is touched).
  • python3 scripts/changelog.py check, python3 scripts/check-doc-ids.py, make docs-check (link checker, after make docs-landing-assets), go run -C tools ./cmd/doc-counts -check ("already current"): pass. No README or docs figure moved.
  • mkdocs build --strict (after make docs-engine-assets): pass.
  • editors/vscode: npm ci && npm test: 342 passed, 0 failed. The landing model's pinned description "Runtime Environment and Development Kit" (src/landing/stack.json, model.test.ts, tests/wasm/landing_model_test.go, docs/assets/opensysml-stack.sysml) is unchanged.
  • editors/mdk: mvn -B -q -f client/java/pom.xml -pl :opensysml -am install -DskipTests then mvn -B -f editors/mdk/pom.xml verify -Dopensysml.requireService=true against a freshly built bin/sysml-grpc: 50 tests, 0 failures, BUILD SUCCESS. DocGenExtensionsTest still asserts the OpenSysML MDK DocGen profile name.

Known red that this branch inherits from develop (not caused here, not fixed here): TestCommittedBaselineStatesThisRepositorysProvenance in tools/referee/apijson fails identically on bare origin/develop (119515349), because docs/project/api-json-differential-baseline.json records 30 testdata files and the errata registry digest of an earlier tree, while the repository now has 32 files and a newer registry. It needs go run -C tools ./cmd/pilot-apijson-diff -update after adjudication, which is outside a brand rename; this branch touches nothing under tools/. It is what fails the "Go tests (rest migrate)" shard on this PR; #1321 and #1322 re-record that baseline, and this branch has no overlap with either.

Overlaps with open PRs: #1302/#1307/#1313/#1315 edit AGENTS.md, CONTRIBUTING.md, README.md and .github/workflows/pr.yml, #1318/#1275/#1308 edit README.md, on lines this PR does not touch. The branch docs/community-project-cards (no PR) rewrites docs/community.md, including the two lines renamed here.

Checklist

  • make test and make lint pass locally (go test ./... apart from the develop-inherited baseline red above; gofmt/go vet clean)
  • Tests added or updated for the change (prose and display-name rename; the existing pins cover the unchanged description)
  • Documentation extended where it already covers the surface (see CONTRIBUTING.md)
  • Changelog entry added as changes/unreleased/<slug>.<section>.md, not as an edit to CHANGELOG.md
  • baselines regenerated and make docs-counts run if a gate count moved (compliance rows need nothing: the census is counted at docs build) — nothing moved; doc-counts -check is current
  • No internal work-item labels (waves, slices, F4, K5) in the body, docs, or changelog

Link to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/b3a9f2862c6f44c49dcb8f9535de812f
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/b3a9f2862c6f44c49dcb8f9535de812f?variant=devin
Requested by: @HuiJun

The brand is OpenSysML MDK, the second generation of OpenMBEE's Model
Development Kit; the description, repository, module path, package and
registry names, binaries, environment variables and RE/DK build names
are unchanged.

Co-Authored-By: jason.han <hanhuijun@gmail.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

With the product named OpenSysML MDK, the Cameo Systems Modeler plugin
takes a qualifier in every display name: README, Maven project names,
the plugin descriptor, dialog titles, the docs and the CI job name. Its
Maven coordinates, plugin id, Java packages and the DocGen profile name
are unchanged.

Co-Authored-By: jason.han <hanhuijun@gmail.com>

@devin-ai-integration devin-ai-integration 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.

🔍 Devin Review: 1 flag

Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)

Devin Review

@devin-ai-integration
devin-ai-integration Bot marked this pull request as ready for review October 21, 2026 08:17
…he OpenSysML suite

Co-Authored-By: jason.han <hanhuijun@gmail.com>
@HuiJun
HuiJun merged commit 1f1d1de into develop Oct 21, 2026
27 checks passed
@HuiJun
HuiJun deleted the chore/mdk-brand-name branch October 21, 2026 19:32
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