Skip to content

Add agent guidance - #205

Merged
Ekhorn merged 2 commits into
mainfrom
add-agents.md
Nov 4, 2026
Merged

Ekhorn merged 2 commits into
mainfrom
add-agents.md

Conversation

@wborn

@wborn wborn commented Nov 4, 2026

Copy link
Copy Markdown
Member

This pull request adds a new AGENTS.md file 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:

  • Introduces rules that override the general documentation maintenance procedures when there is a conflict, ensuring agents follow stricter guidelines for documentation changes.

Documentation structure and versioning:

  • Clearly defines which directories are editable (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:

  • Specifies US English usage, Markdown preferences, technical accuracy, and formatting conventions, including one-sentence-per-line for new content and the use of descriptive headings and code formatting.

Technical and procedural accuracy:

  • Requires agents to verify technical details against source repositories, avoid inventing information, and use placeholders for sensitive data, with clear instructions on handling unverifiable details.

Restrictions on generated and configuration files:

  • Prohibits agents from modifying generated API documentation

@wborn
wborn requested a review from a team November 4, 2026 16:25
Comment thread AGENTS.md Resolved

@Ekhorn Ekhorn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Will approve once the only thread is resolved.

@Ekhorn
Ekhorn enabled auto-merge (squash) November 4, 2026 16:46
@Ekhorn
Ekhorn merged commit 2cbdf39 into main Nov 4, 2026
2 checks passed
@wborn
wborn deleted the add-agents.md branch November 4, 2026 16:57
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.

2 participants