Skip to content

Docs + Agent.md#29

Open
sgillen wants to merge 2 commits intomainfrom
sgillen/agent_md
Open

Docs + Agent.md#29
sgillen wants to merge 2 commits intomainfrom
sgillen/agent_md

Conversation

@sgillen
Copy link
Collaborator

@sgillen sgillen commented Feb 16, 2026

Adds an Agents file as well as update our docs

@greptile-apps
Copy link

greptile-apps bot commented Feb 16, 2026

Greptile Summary

This PR adds documentation infrastructure: a new AGENTS.md with repository guidelines for AI coding assistants and contributors, a comprehensive docs/DESIGN_AND_IMPLEMENTATION.md design guide covering architecture, service APIs, and inline integration instructions, and a cross-link from the README.md. The old docs/images/SERVICES.md (which was misplaced in an images directory) is deleted, with its content consolidated and expanded in the new design doc.

  • AGENTS.md: Provides project structure, build/test commands, coding style conventions, and PR guidelines. All referenced paths and commands verified against actual repo contents.
  • docs/DESIGN_AND_IMPLEMENTATION.md: Detailed architecture guide covering the central monitor node, header-only diagnostics library, UI adapters, and a step-by-step inline integration walkthrough. Code examples verified against greenwave_diagnostics.hpp and minimal_publisher_node.cpp.
  • README.md: Adds a link to the new design doc between the architecture diagram and diagnostic messages sections.
  • docs/images/SERVICES.md (deleted): Content migrated into the new design doc with improved structure and additional detail.

Confidence Score: 5/5

  • This PR is safe to merge — it contains only documentation additions and reorganization with no code changes.
  • Documentation-only PR with no code changes. All file path references, API names, code snippets, and command examples in the new docs were verified against the actual source code and repository structure. The deleted SERVICES.md has no remaining inbound references and its content is fully consolidated in the new doc.
  • No files require special attention.

Important Files Changed

Filename Overview
AGENTS.md New file providing repository guidelines for AI agents/contributors. All referenced paths, commands, and conventions verified against actual repo structure.
README.md Minor addition of a link to the new DESIGN_AND_IMPLEMENTATION.md doc. Link target is correct and well-placed.
docs/DESIGN_AND_IMPLEMENTATION.md Comprehensive new design and integration guide. Consolidates old SERVICES.md content with expanded architecture docs. Code snippets and API references verified against source. One minor inaccuracy found regarding include path.
docs/images/SERVICES.md Deleted file whose content has been consolidated into docs/DESIGN_AND_IMPLEMENTATION.md. No remaining references to this file in the codebase.

Flowchart

flowchart TD
    A["README.md"] -->|new link| B["docs/DESIGN_AND_IMPLEMENTATION.md"]
    C["docs/images/SERVICES.md\n(deleted)"] -.->|content migrated| B
    D["AGENTS.md\n(new)"] --- E["Repository Guidelines:\n- Project Structure\n- Build/Test Commands\n- Coding Style\n- Testing Guidelines\n- PR Guidelines"]
    B --- F["Design & Implementation:\n- Central Monitor Node\n- Diagnostics Core API\n- UI Adapters\n- Inline Integration Guide\n- Service API Reference"]
Loading

Last reviewed commit: 6a265e5

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

4 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

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.

1 participant