Repository navigation
Add agent guidance - #205
Merged
Merged
Conversation
Ekhorn
reviewed
Nov 4, 2026
Ekhorn
reviewed
Nov 4, 2026
Ekhorn
left a comment
Contributor
There was a problem hiding this comment.
Will approve once the only thread is resolved.
Ekhorn
approved these changes
Nov 4, 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.
This pull request adds a new
AGENTS.mdfile to the repository, providing detailed instructions and restrictions specifically for AI agents contributing to the OpenRemote documentation. The document outlines repository structure, versioning, writing guidelines, technical accuracy requirements, and validation steps, and clarifies how these agent-specific rules interact with existing maintenance procedures.Key additions and guidelines for AI agents:
Agent-specific contribution restrictions:
Documentation structure and versioning:
docs/) and which are read-only (versioned_docs/,api/, etc.), and instructs agents not to propagate changes or create new versions unless explicitly required.Writing and formatting standards:
Technical and procedural accuracy:
Restrictions on generated and configuration files: