Update evidence-source location examples to include index.json#20
Merged
Malcolmnixon merged 4 commits intomainfrom Mar 11, 2026
Merged
Update evidence-source location examples to include index.json#20Malcolmnixon merged 4 commits intomainfrom
Malcolmnixon merged 4 commits intomainfrom
Conversation
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
approved these changes
Mar 11, 2026
Contributor
There was a problem hiding this comment.
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.locationexamples to includeindex.jsonfor bothfileshareandurl. - 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>
Contributor
|
@copilot Please fix lint issues |
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Contributor
Author
This was referenced Mar 16, 2026
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.
Description
The
evidence-sourcelocationfield points directly toindex.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:
After:
Files updated
README.md— URL example now includesindex.jsonTHEORY-OF-OPERATIONS.md— source type table descriptions and both location examples updated;filesharerow clarified to indicate access uses OS/share permissions (credentials block applies only tourlsources)docs/guide/guide.md— source type table descriptions and all five location examples (fileshare + URL) updatedSource type table descriptions now read "Full UNC or local file-system path to
index.json" and "Full HTTP or HTTPS URL toindex.json" to make the semantics unambiguous.Type of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.ReviewMark --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
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.