Cleanups from new agents and template repository.#8
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aligns DictionaryMark’s documentation/standards and automation artifacts with newer template conventions (including Shared Package/OTS guidance), while also tightening the test harness and adding a template synchronization agent.
Changes:
- Updated standards + documentation structure/content for verification/design/requirements, including expanded OTS artifacts and references.
- Improved test infrastructure (temporary directory helper + process runner), updated tests accordingly, and refined test namespaces.
- Updated compliance/config files (ReqStream includes, ReviewMark review-sets, docs build definitions) and added a template-sync orchestrator agent.
Reviewed changes
Copilot reviewed 109 out of 110 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| test/DemaConsulting.DictionaryMark.Tests/Utilities/UtilitiesSubsystemTests.cs | Move test to subsystem namespace |
| test/DemaConsulting.DictionaryMark.Tests/Utilities/PathHelpersTests.cs | Move test to unit namespace |
| test/DemaConsulting.DictionaryMark.Tests/SelfTest/ValidationTests.cs | Move test to unit namespace |
| test/DemaConsulting.DictionaryMark.Tests/IntegrationTests.cs | Use TemporaryDirectory; add stderr/stdout assertions |
| test/DemaConsulting.DictionaryMark.Tests/Helpers/TemporaryDirectory.cs | Validate filenames passed to temp dir helper |
| test/DemaConsulting.DictionaryMark.Tests/Helpers/Runner.cs | Add stdout/stderr split + timeout |
| test/DemaConsulting.DictionaryMark.Tests/Dictionary/DictionarySubsystemTests.cs | Use TemporaryDirectory; add end-to-end pipeline test |
| test/DemaConsulting.DictionaryMark.Tests/Cli/ContextTests.cs | Move test to unit namespace |
| src/DemaConsulting.DictionaryMark/SelfTest/Validation.cs | Add constant documentation comments |
| src/DemaConsulting.DictionaryMark/Dictionary/DictionaryEntry.cs | Clarify null-handling in ctor docs |
| src/DemaConsulting.DictionaryMark/Cli/Context.cs | Document log open exception behavior |
| requirements.yaml | Include additional OTS requirement files |
| README.md | Document --definition-header; add build/user guide sections |
| docs/verification/ots/yaml-dot-net.md | Add YamlDotNet OTS verification evidence |
| docs/verification/ots/xunit.md | Rename section + add regression/suitability text |
| docs/verification/ots/weasyprint.md | Rename section + add regression/suitability text |
| docs/verification/ots/versionmark.md | Rename section + add regression/suitability text |
| docs/verification/ots/test-results.md | Add TestResults OTS verification evidence |
| docs/verification/ots/sonarmark.md | Rename section + add regression/suitability text |
| docs/verification/ots/sarifmark.md | Rename section + add regression/suitability text |
| docs/verification/ots/reviewmark.md | Rename section + add regression/suitability text |
| docs/verification/ots/reqstream.md | Add requirements link; rename section; add regression/suitability |
| docs/verification/ots/pandoc.md | Rename section + add regression/suitability text |
| docs/verification/ots/fileassert.md | Rename section + add regression/suitability text |
| docs/verification/ots/file-system-globbing.md | Add FileSystemGlobbing OTS verification evidence |
| docs/verification/ots/buildmark.md | Rename section + add regression text |
| docs/verification/ots.md | Expand OTS list + strategy/evidence text |
| docs/verification/introduction.md | Add releases reference section |
| docs/verification/dictionary-mark/utilities/path-helpers.md | Rename to “Verification Strategy”; add env/criteria sections |
| docs/verification/dictionary-mark/utilities/glob-matcher.md | Rename to “Verification Strategy”; add env/criteria; adjust coverage IDs |
| docs/verification/dictionary-mark/utilities.md | Rename to “Verification Strategy”; add env/criteria; refine requirement mapping |
| docs/verification/dictionary-mark/test-helpers.md | Document TemporaryDirectory/Runner helpers |
| docs/verification/dictionary-mark/self-test/validation.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/self-test.md | Rename to “Verification Strategy”; add env/criteria; reformat scenarios |
| docs/verification/dictionary-mark/program.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/dictionary/yaml-loader.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/dictionary/markdown-formatter.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/dictionary/dictionary-generator.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/dictionary/conflict-detector.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/dictionary.md | Add subsystem strategy + scenarios including generation pipeline |
| docs/verification/dictionary-mark/cli/context.md | Rename to “Verification Strategy”; add env/criteria |
| docs/verification/dictionary-mark/cli.md | Rename to “Verification Strategy”; add env/criteria; refine scenarios |
| docs/verification/dictionary-mark.md | Rename system scenarios section; add new error-handling requirements mapping |
| docs/user_guide/introduction.md | Add references; document --definition-header; tweak option docs |
| docs/requirements_report/introduction.md | Add releases reference section |
| docs/requirements_report/definition.yaml | Comment generated trace matrix input |
| docs/requirements_doc/title.txt | Title update |
| docs/requirements_doc/introduction.md | Add references section |
| docs/requirements_doc/definition.yaml | Comment generated requirements/justifications inputs |
| docs/reqstream/ots/yaml-dot-net.yaml | Add YamlDotNet OTS requirement + test links |
| docs/reqstream/ots/test-results.yaml | Add TestResults OTS requirement + test links |
| docs/reqstream/ots/reqstream.yaml | Expand ReqStream requirement title/justification |
| docs/reqstream/ots/file-system-globbing.yaml | Add FileSystemGlobbing OTS requirement + test links |
| docs/reqstream/dictionary-mark/utilities/path-helpers.yaml | Title formatting cleanup |
| docs/reqstream/dictionary-mark/utilities/glob-matcher.yaml | Split validation requirements; refine titles |
| docs/reqstream/dictionary-mark/utilities.yaml | Split subsystem requirements into file-matching vs path-safety |
| docs/reqstream/dictionary-mark/self-test/validation.yaml | Reword validation requirement titles for deployment emphasis |
| docs/reqstream/dictionary-mark/self-test.yaml | Add explicit version/help self-test children |
| docs/reqstream/dictionary-mark/platform-requirements.yaml | Add explicit Windows/Ubuntu platform requirements |
| docs/reqstream/dictionary-mark/dictionary/markdown-formatter.yaml | Title formatting cleanup |
| docs/reqstream/dictionary-mark/dictionary/conflict-detector.yaml | Title formatting cleanup |
| docs/reqstream/dictionary-mark/dictionary.yaml | Add subsystem-level generation requirement + mapping |
| docs/reqstream/dictionary-mark/cli/context.yaml | Split results flag vs missing-value requirement |
| docs/reqstream/dictionary-mark/cli.yaml | Add children to error-output requirement; include missing-results requirement |
| docs/reqstream/dictionary-mark.yaml | Refine requirement children mappings; add new system error-output requirements |
| docs/design/ots/yaml-dot-net.md | Add YamlDotNet integration design |
| docs/design/ots/test-results.md | Add TestResults integration design |
| docs/design/ots/file-system-globbing.md | Add FileSystemGlobbing integration design |
| docs/design/ots.md | Add OTS dependency overview/policy |
| docs/design/introduction.md | Expand software structure; add explicit OTS companion artifact structure |
| docs/design/dictionary-mark/utilities/path-helpers.md | Restructure headings; add error handling/dependencies/callers |
| docs/design/dictionary-mark/utilities/glob-matcher.md | Restructure headings; add error handling/dependencies/callers |
| docs/design/dictionary-mark/utilities.md | Add subsystem overview/interfaces/design detail |
| docs/design/dictionary-mark/self-test/validation.md | Restructure headings; add error handling/dependencies/callers |
| docs/design/dictionary-mark/self-test.md | Add subsystem overview/interfaces/design detail |
| docs/design/dictionary-mark/program.md | Add interfaces + error handling/dependencies/callers |
| docs/design/dictionary-mark/dictionary/yaml-loader.md | Add error handling/dependencies/callers sections |
| docs/design/dictionary-mark/dictionary/markdown-formatter.md | Add error handling/dependencies/callers sections |
| docs/design/dictionary-mark/dictionary/dictionary-generator.md | Add dependencies/callers sections |
| docs/design/dictionary-mark/dictionary/conflict-detector.md | Add error handling/dependencies/callers sections |
| docs/design/dictionary-mark/dictionary.md | Add subsystem overview/interfaces/design detail |
| docs/design/dictionary-mark/cli/context.md | Add error handling/dependencies/callers sections |
| docs/design/dictionary-mark/cli.md | Add subsystem overview/interfaces/design detail |
| docs/design/dictionary-mark.md | Rework architecture sections; document CLI flags + dependencies + constraints |
| docs/design/definition.yaml | Add ots resource path + include ots.md |
| docs/code_review_report/title.txt | Rename report metadata + add keywords |
| docs/code_review_report/introduction.md | Rewrite purpose/scope; add references |
| docs/code_review_report/definition.yaml | Comment generated report input |
| docs/code_review_plan/title.txt | Rename plan metadata + add keywords |
| docs/code_review_plan/introduction.md | Wording update + references |
| docs/code_review_plan/definition.yaml | Comment generated plan input |
| docs/code_quality/title.txt | Add “Static Analysis” keyword |
| docs/code_quality/introduction.md | Add references section |
| docs/code_quality/definition.yaml | Comment generated CodeQL/Sonar inputs |
| docs/build_notes/title.txt | Rename build notes title |
| docs/build_notes/introduction.md | Expand purpose/scope; add references |
| docs/build_notes/definition.yaml | Comment generated build notes/versions inputs |
| AGENTS.md | Fill repo metadata; add template reference; restructure standards matrix |
| .reviewmark.yaml | Include OTS design docs in architecture review set; add new OTS review-sets |
| .gitignore | Ignore OS metadata files |
| .github/standards/verification-documentation.md | Update structure/terminology; add Shared Package guidance |
| .github/standards/technical-documentation.md | Clarify generated folder policy |
| .github/standards/software-items.md | Add Shared Package category + artifact locations |
| .github/standards/reviewmark-usage.md | Update OTS/shared review-set guidance |
| .github/standards/reqstream-usage.md | Add shared/ subtree guidance + clarify OTS design docs |
| .github/standards/design-documentation.md | Add OTS/shared folder structure + mandatory sections |
| .github/agents/template-sync.agent.md | Add template sync orchestrator agent |
| .github/agents/software-architect.agent.md | Update terminology to include Shared Package |
| .github/agents/quality.agent.md | Update checklist language to match new structure |
| .github/agents/developer.agent.md | Require fetching template counterparts for new files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agent-Logs-Url: https://github.com/demaconsulting/DictionaryMark/sessions/5733e059-ed95-4eaa-94f8-5d82c033b1a6 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
…lable strings Agent-Logs-Url: https://github.com/demaconsulting/DictionaryMark/sessions/81fa6291-7f84-4c0b-b5e5-6bbed9085107 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
added 2 commits
May 20, 2026 17:36
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 123 out of 124 changed files in this pull request and generated 7 comments.
Comments suppressed due to low confidence (1)
docs/design/introduction.md:35
TemporaryDirectoryis now part of the Utilities subsystem, but it is missing from the design introduction's Utilities scope list. Please add it (and its file path) so the Scope section accurately enumerates all Utilities units described/implemented in this repo.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 123 out of 124 changed files in this pull request and generated 6 comments.
Comments suppressed due to low confidence (1)
docs/design/introduction.md:35
- The Utilities subsystem unit list omits
TemporaryDirectory, which was added in this PR and is now used by self-test and test code. Add it here so the design introduction accurately reflects the current software-item inventory.
Agent-Logs-Url: https://github.com/demaconsulting/DictionaryMark/sessions/117db1c2-0f05-4c70-91bf-cb370a32ca42 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/DictionaryMark/sessions/d136343c-0c67-409d-bd86-d5de3172a48f Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/DictionaryMark/sessions/04296e93-382e-4a4d-a034-e378fc39c1f9 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
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 significant improvements to standards and automation agents for software documentation, focusing on better support for "Shared Package" categorization, clearer folder structures, and enhanced repository-template synchronization. The changes update standards, compliance checklists, and agent instructions to reflect these enhancements, and add a new Template Sync agent for automated template conformance.
Standards and Structure Updates:
software-items.md,design-documentation.md,reqstream-usage.md) to recognize "Shared Package" as a first-class software item alongside System, Subsystem, Unit, and OTS, and clarified folder/file organization for shared packages and OTS items. [1] [2] [3] [4]Compliance and Quality Checklist Improvements:
Agent and Automation Enhancements:
template-sync.agent.mdagent, which orchestrates repository auditing and synchronization against canonical templates, supporting multiple operational modes (Audit, Sync, Scaffold, Recreate) and delegating to sub-agents by work group.These changes collectively ensure more robust, template-driven, and standards-compliant documentation and repository structure, with automation support for maintaining conformance.