Add mermaid diagram support to documentation builds

[Copilot]

Pull Request

Description

Enables mermaid diagram rendering in generated documentation by integrating mermaid-filter into the pandoc pipeline. Follows the pattern established in demaconsulting/TestResults.

Changes:

• Added package.json with mermaid-filter 1.4.7 and @mermaid-js/mermaid-cli 11.12.0
• Modified build-docs job: Node.js LTS setup, npm install, and --filter node_modules/.bin/mermaid-filter.cmd on all pandoc invocations
• Updated .gitignore for package-lock.json

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Code quality improvement

Related Issues

Implements feature request for mermaid diagram support in documentation generation.

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

• Code builds successfully: dotnet build --configuration Release
• All tests pass: dotnet test --configuration Release
• Code produces zero warnings

Code Quality

• Code formatting is correct: dotnet format --verify-no-changes
• New code has appropriate XML documentation comments
• Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

• Spell checker passes: cspell "**/*.{md,cs}"
• Markdown linter passes: markdownlint "**/*.md"
• YAML linter passes: yamllint '**/*.{yml,yaml}'

Testing

• Added unit tests for new functionality
• Updated existing tests if behavior changed
• All tests follow the AAA (Arrange, Act, Assert) pattern
• Test coverage is maintained or improved

Documentation

• Updated README.md (if applicable)
• Updated ARCHITECTURE.md (if applicable)
• Added code examples for new features (if applicable)
• Updated requirements.yaml (if applicable)

Additional Notes

No code changes to application logic. Workflow-only modification. Documentation can now include mermaid code blocks that will render as diagrams in generated PDFs.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>[Feature]: Allow mermaid diagrams in documents</issue_title>
<issue_description>### Problem Statement

The build-docs job in build.yaml should support mermaid diagrams in documents.

Proposed Solution

The approach is already in use on https://github.com/demaconsulting/TestResults and involves:

• Copy the package.json file to provide mermaid-filter and mermaid-cli
• Modify the build-docs job of build.yaml to:
  • Use actions/setup-node@v6 to restore the LTS version of node
  • Install NPM dependencies using npm install
  • Add --filter node_modules/.bin/mermaid-filter.cmd to all pandoc invocations

Alternatives Considered

No response

Usage Examples

Benefits

Support for better diagrams in documents.

Priority

Low - Nice to have

Willingness to Contribute

Yes, I can submit a pull request

Additional Context

No response

Checklist

• I have searched existing issues to ensure this is not a duplicate
• I have provided a clear description of the feature
• I have explained why this feature would be useful</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes [Feature]: Allow mermaid diagrams in documents #58

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.