Add reference in AGENTS.md for document location#73
Merged
Malcolmnixon merged 3 commits intomainfrom Mar 31, 2026
Merged
Conversation
Member
|
@copilot Please begin work on this |
Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetLibrary/sessions/76570e71-c9aa-47e8-bb67-2b315a15cb82 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Contributor
Author
Done. Added a short reference to |
Copilot
AI
changed the title
[WIP] Add reference in AGENTS.md for document location
Add reference in AGENTS.md for document location
Mar 31, 2026
Malcolmnixon
requested changes
Mar 31, 2026
Agent-Logs-Url: https://github.com/demaconsulting/TemplateDotNetLibrary/sessions/cc63ed6a-c938-4320-9a33-8fa2516acb0e Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Malcolmnixon
approved these changes
Mar 31, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates repository agent guidance documentation to make the detailed design “System/Subsystem/Unit” breakdown easier to discover via the documented docs/ structure.
Changes:
- Adds a
docs/design/entry to the Project Structure Template inAGENTS.md. - Notes
docs/design/introduction.mdas the location for the System/Subsystem/Unit breakdown.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Adds a reference to
docs/design/introduction.mdinAGENTS.mdso that agents can quickly locate the System/Subsystem/Unit breakdown for the repository.Description
Updated the Project Structure Template section of
AGENTS.mdto list thedocs/design/folder as a sub-entry underdocs/, withintroduction.mdlisted beneath it as plain text describing that it contains the System/Subsystem/Unit breakdown for the repository.Type of Change
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
./lint.sh(Unix/macOS) orcmd /c lint.bat/./lint.bat(Windows)Testing
Documentation
Additional Notes
The change adds a
design/folder entry underdocs/in the Project Structure Template section, withintroduction.mdlisted beneath it as plain text (no link).markdownlintandcspellpass with no issues.