Skip to content

Add SysML2 model support and update related documentation - #169

Merged
Malcolmnixon merged 1 commit into
mainfrom
feature/sysml2-model
Jul 11, 2026
Merged

Add SysML2 model support and update related documentation#169
Malcolmnixon merged 1 commit into
mainfrom
feature/sysml2-model

Conversation

@Malcolmnixon

Copy link
Copy Markdown
Member

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

  • Added the sysml2tools CLI 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]
  • Updated cspell dictionary to recognize sysml and sysml2tools as valid terms (.cspell.yaml).

Documentation and Standards Updates

  • Updated design documentation standards to require SysML2-based diagrams for the Software Structure section and referenced the new SysML2 modeling standard (.github/standards/design-documentation.md). [1] [2]
  • Clarified that version numbers should not be recorded in design documentation, except for standards and protocol identifiers (.github/standards/design-documentation.md).

Review and ReviewMark Process Improvements

  • Added docs/sysml2/**/*.sysml to the list of files requiring review and clarified review-set structure/context handling in .reviewmark.yaml (.github/standards/reviewmark-usage.md).
  • Refined review-set definitions to include SysML2 model files in the Decomposition review, and added explicit context files for each review type to improve reviewer orientation (.github/standards/reviewmark-usage.md). [1] [2] [3] [4] [5]
  • Updated the formal review agent instructions to clarify the distinction between context and files under review, and to ensure reviewers use the context to understand the system before reviewing files (.github/agents/formal-review.agent.md).

Template and Workflow Adjustments

  • Added a dedicated work group for 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.

- 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>
Copilot AI review requested due to automatic review settings July 11, 2026 19:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 sysml2tools into lint.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.

Comment thread .github/workflows/build.yaml
Comment thread .reviewmark.yaml
Comment thread docs/design/test-results-library/io/serializer-helpers.md
@Malcolmnixon
Malcolmnixon merged commit 41d7005 into main Jul 11, 2026
9 checks passed
@Malcolmnixon
Malcolmnixon deleted the feature/sysml2-model branch July 11, 2026 20:45
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.

2 participants