Update project based on template modifications#185
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates BuildMark’s documentation standards/templates and then applies those template-driven structure changes across design, verification, and requirements artifacts. It also refreshes repo tooling/docs (build script, ignore rules, spelling dictionary) to better align with the updated template and compliance automation.
Changes:
- Tightens and clarifies standards for design/verification/requirements documents (mandatory sections, classification rules, and template-sync agent behavior).
- Restructures ReqStream YAML (deeper consistent section nesting) and refreshes many design/verification markdown chapters to match the newer templates.
- Adds user guide content (installation/getting started) and updates build/ignore/tooling metadata for CI-friendly outputs.
Reviewed changes
Copilot reviewed 170 out of 171 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/verification/title.txt | Updates verification document front-matter metadata. |
| docs/verification/build-mark/version/version-commit-tag.md | Refreshes unit verification narrative and acceptance criteria formatting. |
| docs/verification/build-mark/utilities/process-runner.md | Updates ProcessRunner verification text and scenario descriptions. |
| docs/verification/build-mark/self-test/validation.md | Reworks Validation verification content and scenario formatting. |
| docs/verification/build-mark/self-test.md | Aligns SelfTest verification headings/content with updated template language. |
| docs/verification/build-mark/repo-connectors/repo-connector-factory.md | Updates RepoConnectorFactory verification text and formatting. |
| docs/verification/build-mark/repo-connectors/repo-connector-base.md | Updates RepoConnectorBase verification text and formatting. |
| docs/verification/build-mark/repo-connectors/mock/mock-repo-connector.md | Formatting/structure tweaks for MockRepoConnector unit verification. |
| docs/verification/build-mark/repo-connectors/mock.md | Updates Mock subsystem verification summary text. |
| docs/verification/build-mark/repo-connectors/item-router.md | Updates ItemRouter verification summary text. |
| docs/verification/build-mark/repo-connectors/item-controls-parser.md | Updates ItemControlsParser verification summary text and formatting. |
| docs/verification/build-mark/repo-connectors/item-controls-info.md | Updates ItemControlsInfo verification summary and acceptance criteria wording. |
| docs/verification/build-mark/repo-connectors/i-repo-connector.md | Updates IRepoConnector verification summary and acceptance criteria wording. |
| docs/verification/build-mark/repo-connectors/github.md | Updates GitHub subsystem verification summary and test counts. |
| docs/verification/build-mark/repo-connectors/azure-devops.md | Updates Azure DevOps subsystem verification summary and requirement coverage references. |
| docs/verification/build-mark/repo-connectors.md | Updates RepoConnectors subsystem verification summary and coverage listing. |
| docs/verification/build-mark/configuration/section-config.md | Updates SectionConfig verification description and scenario formatting. |
| docs/verification/build-mark/configuration/rule-match-config.md | Updates RuleMatchConfig verification description and scenario formatting. |
| docs/verification/build-mark/configuration/rule-config.md | Updates RuleConfig verification description and scenario formatting. |
| docs/verification/build-mark/configuration/report-config.md | Updates ReportConfig verification text to match current tests and environment details. |
| docs/verification/build-mark/configuration/git-hub-connector-config.md | Updates GitHubConnectorConfig verification scenarios (adds token-variable validation). |
| docs/verification/build-mark/configuration/connector-config.md | Updates ConnectorConfig verification scenarios and wording. |
| docs/verification/build-mark/configuration/configuration-load-result.md | Updates ConfigurationLoadResult verification description/scenarios. |
| docs/verification/build-mark/configuration/configuration-issue.md | Updates ConfigurationIssue verification description/scenarios. |
| docs/verification/build-mark/configuration/build-mark-config.md | Updates BuildMarkConfig verification text/scenario formatting. |
| docs/verification/build-mark/build-notes/web-link.md | Updates WebLink verification narrative and acceptance criteria wording. |
| docs/verification/build-mark/build-notes/item-info.md | Updates ItemInfo verification narrative and scenario formatting. |
| docs/verification/build-mark/build-notes.md | Updates BuildNotes subsystem verification narrative and scenario formatting. |
| docs/user_guide/title.txt | Updates user guide front-matter metadata and keywords. |
| docs/user_guide/installation.md | Adds installation instructions (global/local tool install + update). |
| docs/user_guide/getting-started.md | Adds quickstart usage examples (tokens, known issues flag). |
| docs/user_guide/definition.yaml | Adds new user guide pages to Pandoc definition input list. |
| docs/requirements_report/title.txt | Updates trace matrix document front-matter metadata and keywords. |
| docs/requirements_report/introduction.md | Updates trace matrix introduction (xUnit reference, purpose/scope wording). |
| docs/requirements_report/definition.yaml | Flattens resource-path syntax and annotates generated input file. |
| docs/requirements_doc/title.txt | Updates requirements document front-matter metadata and keywords. |
| docs/requirements_doc/introduction.md | Simplifies requirements doc introduction and references. |
| docs/requirements_doc/definition.yaml | Flattens resource-path syntax and annotates generated inputs. |
| docs/reqstream/build-mark/version/version-tag.yaml | Restructures VersionTag requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/version/version-semantic.yaml | Restructures VersionSemantic requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/version/version-interval.yaml | Restructures VersionInterval requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/version/version-interval-set.yaml | Restructures VersionIntervalSet requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/version/version-commit-tag.yaml | Restructures VersionCommitTag requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/version.yaml | Restructures Version subsystem requirements and adds header comment. |
| docs/reqstream/build-mark/utilities/temporary-directory.yaml | Restructures TemporaryDirectory requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/utilities/process-runner.yaml | Restructures ProcessRunner requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/utilities/path-helpers.yaml | Restructures PathHelpers requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/utilities.yaml | Restructures Utilities subsystem requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/self-test/validation.yaml | Restructures Validation requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/self-test.yaml | Restructures SelfTest subsystem requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/repo-connector-factory.yaml | Restructures RepoConnectorFactory requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/mock/mock-repo-connector.yaml | Restructures MockRepoConnector requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/mock.yaml | Restructures Mock subsystem requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/item-router.yaml | Restructures ItemRouter requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/item-controls-parser.yaml | Restructures ItemControlsParser/Info requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/github.yaml | Restructures GitHub subsystem requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/repo-connectors/azure-devops.yaml | Restructures Azure DevOps subsystem requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/build-notes/web-link.yaml | Restructures WebLink requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/build-notes/item-info.yaml | Restructures ItemInfo requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/build-notes/build-information.yaml | Restructures BuildInformation requirements under new nested section hierarchy. |
| docs/reqstream/build-mark/build-notes.yaml | Restructures BuildNotes subsystem requirements under new nested section hierarchy. |
| docs/reqstream/build-mark.yaml | Renames top-level system section title and adds header comment. |
| docs/design/title.txt | Updates design document front-matter metadata. |
| docs/design/introduction.md | Updates design introduction text (scope, OTS references, exclusions). |
| docs/design/build-mark/version/version-interval-set.md | Expands unit design detail (methods, dependencies/callers). |
| docs/design/build-mark/version/version-commit-tag.md | Refactors unit design format to match new mandatory section scheme. |
| docs/design/build-mark/utilities/temporary-directory.md | Refactors unit design format and adds dependencies/callers sections. |
| docs/design/build-mark/utilities/process-runner.md | Expands ProcessRunner design (method contracts, helper behavior). |
| docs/design/build-mark/utilities/path-helpers.md | Refactors PathHelpers design with explicit contracts and callers. |
| docs/design/build-mark/self-test.md | Refactors SelfTest subsystem design into a more explicit interface/behavior description. |
| docs/design/build-mark/repo-connectors/mock.md | Refactors Mock subsystem design to more explicit algorithm steps. |
| docs/design/build-mark/repo-connectors/item-router.md | Expands ItemRouter design and clarifies rule evaluation/section creation. |
| docs/design/build-mark/repo-connectors/item-controls-info.md | Refactors ItemControlsInfo design with explicit fields/dependencies/callers. |
| docs/design/build-mark/repo-connectors/github/github-graphql-types.md | Expands GitHubGraphQLTypes data model documentation and dependencies/callers. |
| docs/design/build-mark/configuration/section-config.md | Refactors SectionConfig design format and callers list. |
| docs/design/build-mark/configuration/rule-config.md | Refactors RuleConfig design and clarifies RuleMatchConfig fields. |
| docs/design/build-mark/configuration/report-config.md | Refactors ReportConfig design with validation notes and callers list. |
| docs/design/build-mark/configuration/connector-config.md | Refactors ConnectorConfig design and clarifies role in connector selection. |
| docs/design/build-mark/configuration/configuration-load-result.md | Expands ConfigurationLoadResult design (ReportTo contract + dependencies/callers). |
| docs/design/build-mark/configuration/configuration-issue.md | Refactors ConfigurationIssue design and clarifies severity enum meaning. |
| docs/design/build-mark/configuration/build-mark-config.md | Expands BuildMarkConfig design (CreateDefault contract + dependencies/callers). |
| docs/design/build-mark/configuration/build-mark-config-reader.md | Expands BuildMarkConfigReader design (ReadAsync contract + dependencies/callers). |
| docs/design/build-mark/cli.md | Refactors CLI subsystem design and makes Context contracts explicit. |
| docs/design/build-mark/build-notes/web-link.md | Refactors WebLink design with dependencies/callers. |
| docs/design/build-mark/build-notes/item-info.md | Refactors ItemInfo design with dependencies/callers. |
| docs/design/build-mark/build-notes.md | Refactors BuildNotes subsystem design with explicit interface contracts. |
| docs/code_review_report/title.txt | Updates code review report front-matter metadata and keywords. |
| docs/code_review_report/introduction.md | Updates code review report introduction wording and references. |
| docs/code_review_report/definition.yaml | Adds an explanatory comment for generated report input. |
| docs/code_review_plan/title.txt | Updates code review plan front-matter metadata and keywords. |
| docs/code_review_plan/introduction.md | Updates code review plan introduction wording and references. |
| docs/code_review_plan/definition.yaml | Adds an explanatory comment for generated plan input. |
| docs/code_quality/title.txt | Updates code quality report front-matter metadata and keywords. |
| docs/code_quality/introduction.md | Updates code quality report introduction wording (scope, references). |
| docs/code_quality/definition.yaml | Minor formatting cleanup in definition YAML. |
| docs/build_notes/title.txt | Updates build notes document front-matter metadata and keywords. |
| docs/build_notes/introduction.md | Updates build notes introduction wording and scope. |
| docs/build_notes/definition.yaml | Flattens resource-path syntax and annotates generated inputs. |
| build.ps1 | Updates build script to restore, build, and produce TRX results under artifacts/tests. |
| AGENTS.md | Updates agent guidance metadata and adds US English spelling directive (but leaves TODOs). |
| .yamlfix.toml | Simplifies yamlfix config file by removing explanatory header block. |
| .gitignore | Reworks ignore rules (adds artifacts/, normalizes sections, cleans up entries). |
| .github/standards/verification-documentation.md | Updates verification doc rules (mandatory sections, classification source, traceability guidance). |
| .github/standards/testing-principles.md | Removes redundant preamble text and keeps core standards. |
| .github/standards/technical-documentation.md | Simplifies and clarifies technical documentation standards wording. |
| .github/standards/software-items.md | Clarifies placeholder forms and subsystem nesting notation; tightens OTS/shared guidance. |
| .github/standards/design-documentation.md | Updates design doc rules (mandatory sections, no version numbers, dependencies/callers split). |
| .github/standards/csharp-testing.md | Removes redundant checklist preface text. |
| .github/standards/csharp-language.md | Removes redundant explanatory preface text. |
| .github/standards/coding-principles.md | Simplifies wording and clarifies full-symbol documentation expectations. |
| .github/agents/template-sync.agent.md | Strengthens template-sync recreate/scaffold instructions and adds new reporting field. |
| .cspell.yaml | Adds new dictionary words used by updated standards/docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Member
Author
|
@copilot The build is failing with: File 'D:\a\BuildMark\BuildMark\docs/generated/BuildMark Build Notes.pdf' PDF metadata 'Subject' does not contain 'Build notes' Please make sure the .fileassert.yaml file matches the information in the title.txt files of the documents. It is case sensitive. |
Contributor
Updated in commit |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@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.
Pull Request
Description
Updates the project based on template modifications. Includes corrections to verification documentation to fix inaccurate test counts and replace obsolete "Requirements Coverage mapping" references with "ReqStream trace matrix" references per the updated verification documentation standard.
Verification Doc Fixes
GitHubRepoConnectorTests.cstest count from 25 → 27 to match actual[Fact]countAzureDevOpsRepoConnectorTests.cstest count from 25 → 32 to match actual[Fact]countType of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
pwsh ./build.ps1Code Quality
Quality Checks
Please run the following checks before submitting:
pwsh ./lint.ps1Testing
Documentation
Additional Notes
Documentation-only changes to verification docs. No code or test changes.