Repository navigation
Refresh developer documentation and add agent guidance - #2469
Merged
Merged
Conversation
Since moving to the new SLNX format, we have not updated our VSCode build and launch tasks for the new solution file target, nor the updated repository layout. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
Update the documentation index, splitting out user and developer documentation articles. Add missing links. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
The development and debugging document has falled behind reality in many places. Let's spruce this up and make it correct to today's situation. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
Update the architecture document to reflect the latest interactions and relationships between projects, commands, and providers. Replace diagrams with Mermaid diagrams where appropriate. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
Update the CONTRIBUTING.md document for the new build system, and call our best practice for drafting commits. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
The spec still described credential-only responses and mandatory external UI helpers. Align it with the current response, protocol, detection, and prompting contracts so provider authors have accurate guidance. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
Add an AGENTS.md file to help AI agents conform to the project best practices. We have existing documentation for many things, so this document is just a high level summary with links to the existing docs for more in depth guidance. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
mjcheetham
added
engineering
dscho
approved these changes
Oct 9, 2026
dscho
left a comment
dscho
left a comment
Contributor
There was a problem hiding this comment.
This looks good to me. I appreciate in particular the updates of stale or outdated information such as documenting the dispatcher and what's going on with Avalonia and .NET 10!
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
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
3 participants
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.
This PR brings GCM's developer documentation and VS Code configuration up to date, then adds an
AGENTS.mdentry point for AI-assisted contributions. Several guides still described the old project layout, .NET Framework/WPF UI helpers, or credential-only provider responses, making them misleading for contributors.