Skip to content

Add SysML2 architecture model and refactor documentation#97

Merged
Malcolmnixon merged 3 commits into
mainfrom
feature/sysml2-upgrade
Jul 11, 2026
Merged

Add SysML2 architecture model and refactor documentation#97
Malcolmnixon merged 3 commits into
mainfrom
feature/sysml2-upgrade

Conversation

@Malcolmnixon

Copy link
Copy Markdown
Member

This pull request introduces a new planning agent and makes significant improvements to the agent orchestration, quality, and review processes. The changes clarify companion artifact requirements, strengthen traceability, and improve reporting consistency across the developer workflow. There are also updates for SysML2 tool integration and spellchecking.

Agent Workflow and Reporting Improvements

  • Added a dedicated planning agent (.github/agents/planning.agent.md) that investigates the codebase, produces a verified implementation plan, and identifies all required companion artifacts. The agent provides a structured report and lean summary for orchestration.
  • Refactored the implementation agent (.github/agents/implementation.agent.md) to use the new planning agent, clarified state transitions, and updated reporting to include report file paths and last active state. The planning companion artifact table is now explicitly passed to the quality agent, and unknowns are clearly reported when the result is INCOMPLETE. [1] [2] [3] [4] [5]
  • The quality agent (.github/agents/quality.agent.md) now cross-references the planning companion artifact table, explicitly requires verification documentation, and improves compliance criteria for all artifact categories. Reporting now includes the report file path. [1] [2] [3] [4]
  • The formal review agent (.github/agents/formal-review.agent.md) clarifies the review process, especially regarding the use of context files and the structure of completion reports.
  • Updated developer and lint-fix agent report templates for consistency and to reference report file paths. [1] [2] [3]

Artifact and Documentation Management

  • Companion artifact requirements are now more explicit and comprehensive throughout all agent instructions, including requirements, design, verification, tests, review-sets, README, and user guides. [1] [2] [3]

Template and SysML2 Tooling

  • The template-sync agent (.github/agents/template-sync.agent.md) now recognizes docs/sysml2/ as a dedicated group, adds groups for root files in documentation folders, and clarifies template matching and error handling. [1] [2]
  • Added demaconsulting.sysml2tools.tool to .config/dotnet-tools.json and updated spellcheck configuration for demaconsulting, sysml, and sysml2tools. [1] [2] [3]

These changes collectively improve traceability, compliance, and clarity in the development and review lifecycle.

Malcolm Nixon and others added 2 commits July 10, 2026 22:46
…ring

Mirrors the SysML2 upgrade previously applied to FileAssert (commit 43f482f):

- Wire up sysml2tools (dotnet-tools.json, .versionmark.yaml, lint.ps1, build.yaml)
- Add docs/sysml2/ model (System/Subsystem/Unit part defs, OTS parts) and views
- Render design-views.sysml to SVG diagrams in docs/design/generated during build
- Embed diagrams in docs/design markdown files
- Refactor docs/design/introduction.md and docs/verification/introduction.md to
  follow the template and reference the rendered SoftwareStructureView diagram
- Refactor .reviewmark.yaml: global context, scoped Purpose, new Decomposition
  and OTS-* review-sets, per-review-set context blocks
- Add reqstream OTS requirement files for YamlDotNet, FileSystemGlobbing,
  DemaConsulting.TestResults, and SysML2Tools
- Fix review findings surfaced by formal-review agents: added SysML2Tools
  cross-reference to docs/design/ots.md, split a compound OTS requirement,
  and linked the orphaned Load requirements into the SysML2 model

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Scope: replace verbose per-subsystem prose with the template's concise
  local/OTS item bullet lists and out-of-scope list
- Software Structure: drop the redundant summary paragraph after the diagram
- Folder Layout: replace the file-level tree with a folders-only bullet list

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 11, 2026 03:03

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 a SysML2-based architecture model (rendered into the design documentation via SysML2Tools) and refactors the repository’s agent workflow/standards/docs to treat the SysML2 model as the authoritative source for software structure.

Changes:

  • Added SysML2 model/view sources under docs/sysml2/, integrated SysML2Tools into local tooling, linting, and CI rendering/self-validation, and embedded generated SVG diagrams throughout design docs.
  • Expanded/updated requirements, design, and verification artifacts to include new/updated OTS items (including SysML2Tools) and to align documentation structure with the new modeling approach.
  • Refactored agent orchestration and standards (planning/quality/review/template-sync/etc.) to improve companion-artifact traceability, reporting consistency, and review-set context.

Reviewed changes

Copilot reviewed 69 out of 69 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
requirements.yaml Adds ReqStream includes for new OTS requirement files (including SysML2Tools and runtime deps).
lint.ps1 Runs sysml2tools lint (when docs/sysml2 exists) as part of dotnet-tools linting.
docs/verification/ots/sysml2tools.md Adds verification evidence/approach for SysML2Tools OTS item.
docs/verification/ots.md Updates OTS self-validation discussion to include SysML2Tools.
docs/verification/introduction.md Adds SysML2Tools to the OTS list and removes the hand-maintained software-structure tree.
docs/verification/definition.yaml Includes SysML2Tools verification doc in the verification document build inputs.
docs/sysml2/views/design-views.sysml Defines named views that SysML2Tools renders into design diagrams.
docs/sysml2/model/version-mark/utilities/path-helpers.sysml Adds SysML2 unit model metadata for PathHelpers and artifact locations.
docs/sysml2/model/version-mark/utilities/glob-matcher.sysml Adds SysML2 unit model metadata for GlobMatcher and artifact locations.
docs/sysml2/model/version-mark/utilities.sysml Adds SysML2 subsystem model for Utilities and child parts.
docs/sysml2/model/version-mark/self-test/validation.sysml Adds SysML2 unit model metadata for Validation and artifact locations.
docs/sysml2/model/version-mark/self-test.sysml Adds SysML2 subsystem model for SelfTest and child parts.
docs/sysml2/model/version-mark/publishing/markdown-formatter.sysml Adds SysML2 unit model metadata for MarkdownFormatter and artifact locations.
docs/sysml2/model/version-mark/publishing.sysml Adds SysML2 subsystem model for Publishing and child parts.
docs/sysml2/model/version-mark/configuration/version-mark-config.sysml Adds SysML2 unit model metadata for VersionMarkConfig and artifact locations.
docs/sysml2/model/version-mark/configuration/tool-config.sysml Adds SysML2 unit model metadata for ToolConfig and artifact locations.
docs/sysml2/model/version-mark/configuration/lint-issue.sysml Adds SysML2 unit model metadata for LintIssue and artifact locations.
docs/sysml2/model/version-mark/configuration.sysml Adds SysML2 subsystem model for Configuration and child parts.
docs/sysml2/model/version-mark/cli/program.sysml Adds SysML2 unit model metadata for Program and artifact locations.
docs/sysml2/model/version-mark/cli/context.sysml Adds SysML2 unit model metadata for Context and artifact locations.
docs/sysml2/model/version-mark/cli.sysml Adds SysML2 subsystem model for Cli and child parts.
docs/sysml2/model/version-mark/capture/version-info.sysml Adds SysML2 unit model metadata for VersionInfo and artifact locations.
docs/sysml2/model/version-mark/capture.sysml Adds SysML2 subsystem model for Capture and child parts.
docs/sysml2/model/version-mark.sysml Adds SysML2 system model for VersionMark including subsystem composition and OTS parts.
docs/sysml2/model/ots.sysml Adds SysML2 OTS dependency part definitions for modeled OTS items.
docs/reqstream/ots/yaml-dot-net.yaml Adds ReqStream requirements for YamlDotNet OTS functionality used by VersionMark.
docs/reqstream/ots/sysml2tools.yaml Adds ReqStream requirements for SysML2Tools lint/render behaviors.
docs/reqstream/ots/microsoft-extensions-file-system-globbing.yaml Adds ReqStream requirements for FileSystemGlobbing OTS functionality used by VersionMark.
docs/reqstream/ots/dema-consulting-test-results.yaml Adds ReqStream requirements for TestResults OTS functionality used by VersionMark.
docs/design/version-mark/utilities/path-helpers.md Embeds the Utilities subsystem diagram near the top of the unit design doc.
docs/design/version-mark/utilities/glob-matcher.md Embeds the Utilities subsystem diagram near the top of the unit design doc.
docs/design/version-mark/utilities.md Embeds the Utilities subsystem diagram near the top of the subsystem design doc.
docs/design/version-mark/self-test/validation.md Embeds the SelfTest subsystem diagram near the top of the unit design doc.
docs/design/version-mark/self-test.md Embeds the SelfTest subsystem diagram near the top of the subsystem design doc.
docs/design/version-mark/publishing/markdown-formatter.md Embeds the Publishing subsystem diagram near the top of the unit design doc.
docs/design/version-mark/publishing.md Embeds the Publishing subsystem diagram near the top of the subsystem design doc.
docs/design/version-mark/configuration/version-mark-config.md Embeds the Configuration subsystem diagram near the top of the unit design doc.
docs/design/version-mark/configuration/tool-config.md Embeds the Configuration subsystem diagram near the top of the unit design doc.
docs/design/version-mark/configuration/lint-issue.md Embeds the Configuration subsystem diagram near the top of the unit design doc.
docs/design/version-mark/configuration.md Embeds the Configuration subsystem diagram near the top of the subsystem design doc.
docs/design/version-mark/cli/program.md Embeds the Cli subsystem diagram near the top of the unit design doc.
docs/design/version-mark/cli/context.md Embeds the Cli subsystem diagram near the top of the unit design doc.
docs/design/version-mark/cli.md Embeds the Cli subsystem diagram near the top of the subsystem design doc.
docs/design/version-mark/capture/version-info.md Embeds the Capture subsystem diagram near the top of the unit design doc.
docs/design/version-mark/capture.md Embeds the Capture subsystem diagram near the top of the subsystem design doc.
docs/design/version-mark.md Embeds the VersionMark system diagram near the top of the system design doc.
docs/design/ots/sysml2tools.md Adds OTS design doc describing SysML2Tools features and integration points.
docs/design/ots.md Updates OTS integration overview to include SysML2Tools as a build-time tool.
docs/design/introduction.md Refactors scope/structure sections to use SysML2 model + rendered diagram instead of a text tree.
docs/design/definition.yaml Adds OTS design docs (including SysML2Tools) to Pandoc design document build inputs.
AGENTS.md Updates navigation guidance to prefer SysML2 model querying and adds sysml2-modeling.md to the standards matrix.
.versionmark.yaml Adds SysML2Tools to captured tool versions for version tracking.
.reviewmark.yaml Adds sysml2 files to review scope, introduces global/per-review context, and adds/updates review sets (including SysML2Tools).
.github/workflows/build.yaml Adds SysML2Tools version capture, self-validation, and SVG rendering during the build-docs job.
.github/standards/technical-documentation.md Tightens the 120-character line guidance wording.
.github/standards/sysml2-modeling.md Introduces SysML2 modeling/viewing/embedding/lint/render standards for this repo.
.github/standards/software-items.md Notes SysML2 comment metadata for artifact-location discovery.
.github/standards/reviewmark-usage.md Updates ReviewMark usage guidance to include sysml2 scope and context file patterns.
.github/standards/design-documentation.md Updates design-doc standards to require SysML2-rendered structure diagrams (and clarifies version-number guidance placement).
.github/skills/sysml2tools-query/SKILL.md Adds a skill doc describing how to query the SysML2 model with SysML2Tools.
.github/agents/template-sync.agent.md Updates grouping/orchestration/reporting rules, including docs/sysml2/ grouping and unresolved-question handling.
.github/agents/quality.agent.md Strengthens companion-artifact enforcement and adds explicit verification-doc compliance checks and report-path reporting.
.github/agents/planning.agent.md Adds a new planning agent with an implementation plan + companion-artifact deliverables template.
.github/agents/lint-fix.agent.md Updates lint-fix report template to include report file path.
.github/agents/implementation.agent.md Refactors orchestration to use the planning agent and improves state/reporting fields.
.github/agents/formal-review.agent.md Clarifies formal review steps and adds report file path to the report template.
.github/agents/developer.agent.md Updates companion-artifact categories and adds report file path to the report template.
.cspell.yaml Adds demaconsulting, sysml, and sysml2tools to the dictionary.
.config/dotnet-tools.json Adds demaconsulting.sysml2tools.tool to the local dotnet tool manifest.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .reviewmark.yaml Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 11, 2026 03:23

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

Copilot reviewed 69 out of 69 changed files in this pull request and generated 2 comments.

Comment thread .github/standards/technical-documentation.md
Comment thread .github/standards/reviewmark-usage.md
@Malcolmnixon
Malcolmnixon merged commit 1ba1308 into main Jul 11, 2026
16 checks passed
@Malcolmnixon
Malcolmnixon deleted the feature/sysml2-upgrade branch July 11, 2026 03:35
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