Skip to content

Update evidence-source location examples to include index.json#20

Merged
Malcolmnixon merged 4 commits intomainfrom
copilot/update-examples-documentation
Mar 11, 2026
Merged

Update evidence-source location examples to include index.json#20
Malcolmnixon merged 4 commits intomainfrom
copilot/update-examples-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 11, 2026

Description

The evidence-source location field points directly to index.json (not a base directory), supporting future migration to REST endpoints with optional query strings. All documentation examples were showing bare directory paths/URLs without the filename.

Before:

evidence-source:
  type: fileshare
  location: \\reviews.example.com\evidence\

After:

evidence-source:
  type: fileshare
  location: \\reviews.example.com\evidence\index.json

Files updated

  • README.md — URL example now includes index.json
  • THEORY-OF-OPERATIONS.md — source type table descriptions and both location examples updated; fileshare row clarified to indicate access uses OS/share permissions (credentials block applies only to url sources)
  • docs/guide/guide.md — source type table descriptions and all five location examples (fileshare + URL) updated

Source type table descriptions now read "Full UNC or local file-system path to index.json" and "Full HTTP or HTTPS URL to index.json" to make the semantics unambiguous.

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

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 unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.ReviewMark --configuration Release --framework net10.0
    --no-build -- --validate
  • 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 .

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

Documentation-only change; no code or test modifications required.


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to include index.json in evidence source Update evidence-source location examples to include index.json Mar 11, 2026
@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 11, 2026 23:17
Copilot AI review requested due to automatic review settings March 11, 2026 23:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates documentation examples to reflect that evidence-source.location should point to the full index.json path/URL, aligning docs with the current EvidenceSource.Location semantics in the codebase.

Changes:

  • Update evidence-source.location examples to include index.json for both fileshare and url.
  • Clarify source-type table descriptions to explicitly say “full path/URL to index.json”.
  • Apply these updates consistently across README, theory-of-operations, and the user guide.

Reviewed changes

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

File Description
README.md Updates the URL example to include index.json.
THEORY-OF-OPERATIONS.md Updates examples and source-type table wording to specify full index.json URL/path.
docs/guide/guide.md Updates multiple guide examples and the source-type table to include index.json.

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

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon
Copy link
Copy Markdown
Contributor

@copilot Please fix lint issues

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Mar 11, 2026

@copilot Please fix lint issues

Fixed in 425a392 — the fileshare row in THEORY-OF-OPERATIONS.md was 160 characters, exceeding the MD013 120-character limit. Shortened the description to stay within the limit.

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.

3 participants