Interconnection views: allow a layout direction and ranking by metadata in Mermaid output
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- go
- Domain
- cli, data-visualization
Research direction
The issue names the Mermaid output path for interconnection views (-render-form mermaid), which always writes flowchart LR, and the DOT rankdir setting. Before coding, ask the maintainers whether direction should be a CLI flag or read from view metadata, since the issue offers both. Done means a view can set the layout direction and order sibling parts by a named metadata attribute, with the output matching the reporter's test model.
Written by the indexing model from the issue text.
Description
When rendering an interconnection view with -render-form mermaid, OpenSysML 0.12.1 always writes flowchart LR, so nested parts are laid out left to right. We model a layered platform architecture where each layer is a part, and the convention for our diagrams is that layer 1 sits at the top and the last layer at the bottom. At the moment there is no way to get that from a declared view.
Two features would let us generate these diagrams directly from the model:
A layout direction for a view. For example, a render option such as -render-direction TB|LR|BT|RL, or a view-level setting read from metadata, which sets the Mermaid flowchart direction for interconnection views (and DOT rankdir for the DOT form).
Ranking by a metadata attribute. An option that orders sibling parts by the value of a named metadata attribute (for us, a layer position), so that the order on the page follows the model and not the declaration order. In Mermaid this can be done with invisible links between consecutive ranks, which we have tested with Pele 1.13.0, the Mermaid renderer Obsidian uses: it keeps the order top to bottom.
Environment: OpenSysML 0.12.1 (commit b2f0e9b), macOS, rendering for Obsidian (Mermaid) and D2.
We are happy to provide a small test model that shows the case.
- Dominant language
- Go
- Stars
- 59
- Forks
- 20
- Avg merge
- 10h 23m
- Merged PRs (30d)
- 897
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Open-MBEE/OpenSysML
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
A model's parse is still paid cold in every process; the library record cache does not cover itOpen
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 28/100
Maintainers usually reply within 1 day
All issues in Open-MBEE/OpenSysML
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
krakenhavoc/cmd_and_ctrl#5853 ·
Maintainers usually reply within 1 day
-
flaky test: TestTRTAsyncPrefillFailures/transport reads the token load before prefillDone has released itPossibly taken @Jackmeson1 claimed this today. Openarea/cicd area/gateway kind/misc
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
vllm-project/aibrix#3488 · 2 comments ·
Maintainers usually reply within 1 day
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
projectdiscovery/httpx#2735 ·
Maintainers usually reply within 1 day
-
NuGet registry builds every URL from ROOT_URL, ignoring the host the client usedPossibly taken @gritse claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day