Skip to content

docs(roadmap): propose an MTIP export as an optional layout augment to a SysML v1 migration - #529

Merged
HuiJun merged 2 commits into
developfrom
docs/roadmap-mtip-layout-augment
Sep 22, 2026
Merged

HuiJun merged 2 commits into
developfrom
docs/roadmap-mtip-layout-augment

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

What and why

A Cameo/MagicDraw .mdzip migrated through sysml -convert sysml carries which elements each diagram shows (#524 writes them as view usages) but not where the diagram draws them — the tool keeps diagram geometry outside the XMI. Open-MBEE's MTIP plugin (mtip-cameo) reads that geometry through the tool's API and writes it into its HUDS XML (per-diagram bounds, connector breakpoints, colors, fonts, images, keyed by element id).

This adds a fourth item under Proposed in docs/project/roadmap.md: read an MTIP export as an optional augment (-layout <mtip-export.xml>), not as a second input format. The .mdzip/.xmi stays the one source of structure and behavior; the HUDS file contributes presentation only, joined to the migrated views by element id and written as the landed DiagramLayout metadata (metadata Layout about …, metadata Route about …, @Canvas) in the view usage's body — standard metadata, not a sidecar. The item states what is refused or reported (unmatched ids, skipped diagrams, malformed records, an export from a different project; colors/fonts/images that DiagramLayout has no attribute for), that output without -layout is byte-identical to today's, that fixtures come from MTIP's own test exports plus a hand-written pair, and that the gate is an MTIP export of a model whose .mdzip is also available — none exists yet, so the item is not started. The "What remains open" Proposed bullet is threaded accordingly.

Roadmap-only; no code, no changelog fragment (as with earlier roadmap-only edits).

How it was verified

  • python3 scripts/check-doc-links.py — 0 broken links
  • python3 scripts/check-doc-ids.py — no internal work-item labels
  • python3 -m mkdocs build --strict — passes

Checklist

  • make test and make lint pass locally (docs-only change; the documentation gates above are the relevant ones)
  • Tests added or updated for the change (n/a — roadmap text)
  • 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 (n/a — roadmap-only edits carry none)
  • baselines regenerated and make docs-counts run if a gate count moved (no count moved)
  • No internal work-item labels (waves, slices, F4, K5) in the body, docs, or changelog

…o a SysML v1 migration

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

@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: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@HuiJun
HuiJun marked this pull request as ready for review September 22, 2026 14:31
…ent join

Co-Authored-By: jason.han <hanhuijun@gmail.com>
@HuiJun
HuiJun merged commit 49f63af into develop Sep 22, 2026
15 checks passed
@HuiJun
HuiJun deleted the docs/roadmap-mtip-layout-augment branch September 22, 2026 16:49
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