Add SysML2 model support and update related documentation - #169
Merged
Conversation
- Scaffold docs/sysml2/ model and design-views with sysml2tools wired into lint.ps1, build.yaml, .config/dotnet-tools.json, .versionmark.yaml - Refactor docs/design/introduction.md to reference the generated SoftwareStructureView diagram instead of a hand-maintained tree - Embed per-subsystem/unit diagrams across docs/design/test-results-library/** - Rework .reviewmark.yaml to match the updated reviewmark-usage standard (Purpose/Decomposition review-sets, context blocks, NamespaceDoc.cs relocated to their owning system/subsystem review-sets) - Fix docs/design/test-results-library/io/serializer-helpers.md heading (Key Properties -> Key Methods) found during formal review - Add sysml, sysml2tools to cspell words Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces first-class SysML2 modeling as the authoritative source for the repository’s software structure, integrates sysml2tools into linting/CI, and updates standards/review configuration so design documentation and formal reviews consistently reference the model.
Changes:
- Add a SysML2 model (
docs/sysml2/**) plus rendered design views, and embed those diagrams into design docs. - Integrate
sysml2toolsintolint.ps1, CI document generation, VersionMark capture, and the local dotnet tool manifest. - Update ReviewMark configuration and repository standards/agent instructions to treat SysML2 as the primary structure source.
Reviewed changes
Copilot reviewed 34 out of 34 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
lint.ps1 |
Adds SysML2 model linting via sysml2tools in the compliance-tools section. |
docs/sysml2/views/design-views.sysml |
Defines rendered views used to generate SVG diagrams for design docs. |
docs/sysml2/model/test-results-library.sysml |
Adds the system-level SysML2 model definition for TestResultsLibrary. |
docs/sysml2/model/test-results-library/io.sysml |
Adds the IO subsystem model and its child parts. |
docs/sysml2/model/test-results-library/io/serializer.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/sysml2/model/test-results-library/io/serializer-helpers.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/sysml2/model/test-results-library/io/trx-serializer.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/sysml2/model/test-results-library/io/junit-serializer.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/sysml2/model/test-results-library/test-outcome.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/sysml2/model/test-results-library/test-result.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/sysml2/model/test-results-library/test-results.sysml |
Adds a unit-level SysML2 part definition with artifact references. |
docs/design/introduction.md |
Replaces hand-maintained structure tree with SysML2-derived diagram + narrative. |
docs/design/test-results-library.md |
Embeds SysML2-rendered diagram into the system design doc. |
docs/design/test-results-library/io.md |
Embeds SysML2-rendered diagram into the IO subsystem design doc. |
docs/design/test-results-library/io/serializer.md |
Embeds IO diagram into unit design doc. |
docs/design/test-results-library/io/serializer-helpers.md |
Embeds IO diagram and adjusts section structure. |
docs/design/test-results-library/io/trx-serializer.md |
Embeds IO diagram into unit design doc. |
docs/design/test-results-library/io/junit-serializer.md |
Embeds IO diagram into unit design doc. |
docs/design/test-results-library/test-outcome.md |
Embeds system diagram into unit design doc. |
docs/design/test-results-library/test-result.md |
Embeds system diagram into unit design doc. |
docs/design/test-results-library/test-results.md |
Embeds system diagram into unit design doc. |
AGENTS.md |
Updates agent navigation guidance to query SysML2 model first. |
.versionmark.yaml |
Captures sysml2tools version for build provenance. |
.reviewmark.yaml |
Adds SysML2 files to needs-review and expands review-set context handling. |
.github/workflows/build.yaml |
Captures sysml2tools version, runs self-validation, and renders diagrams during doc build. |
.github/standards/sysml2-modeling.md |
Adds a SysML2 modeling standard (structure, comments, views, CI integration). |
.github/standards/software-items.md |
Notes SysML2 comment metadata for artifact locations. |
.github/standards/reviewmark-usage.md |
Documents context handling and adds SysML2 model files to review coverage guidance. |
.github/standards/design-documentation.md |
Requires SysML2-rendered diagrams for Software Structure and clarifies version-number guidance. |
.github/skills/sysml2tools-query/SKILL.md |
Adds a skill doc for querying the SysML2 model using sysml2tools. |
.github/agents/template-sync.agent.md |
Adds a dedicated template-sync work group for docs/sysml2/. |
.github/agents/formal-review.agent.md |
Clarifies context vs. reviewed files for formal reviews. |
.cspell.yaml |
Adds sysml/sysml2tools to the dictionary. |
.config/dotnet-tools.json |
Pins and installs the demaconsulting.sysml2tools.tool local tool. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces first-class support for SysML2 architecture modeling and querying in the repository, updates review and documentation standards to integrate SysML2 models, and refines formal review and context file handling. The most important changes are grouped by theme below.
SysML2 Model Integration
sysml2toolsCLI as a pinned .NET tool (.config/dotnet-tools.json) and documented its usage for querying the SysML2 architecture model in a new skill file (.github/skills/sysml2tools-query/SKILL.md). [1] [2]sysmlandsysml2toolsas valid terms (.cspell.yaml).Documentation and Standards Updates
.github/standards/design-documentation.md). [1] [2].github/standards/design-documentation.md).Review and ReviewMark Process Improvements
docs/sysml2/**/*.sysmlto the list of files requiring review and clarified review-set structure/context handling in.reviewmark.yaml(.github/standards/reviewmark-usage.md).Decompositionreview, and added explicit context files for each review type to improve reviewer orientation (.github/standards/reviewmark-usage.md). [1] [2] [3] [4] [5].github/agents/formal-review.agent.md).Template and Workflow Adjustments
docs/sysml2/files in the template sync agent (.github/agents/template-sync.agent.md).These changes ensure that SysML2 models are a central, authoritative source for software structure, and that all review and documentation workflows consistently reference and validate against the SysML2 architecture model.