feat(docs): add Agent Guide for indexer-core usage and integration

[daithihearn]

Summary by CodeRabbit

• Documentation
  • Streamlined internal Claude configuration documentation.
  • Added comprehensive guidance documentation for the indexer-core library, including core components and runtime modes.

[coderabbitai]

📝 Walkthrough

Walkthrough

The CLAUDE.md file was significantly condensed to a single directive against duplicating project guidance, while a new AGENTS.md documentation file was introduced providing a canonical guide for agents working with the indexer-core library, covering core components, runtime modes, and development workflows.

Changes

Cohort / File(s)	Summary
Documentation Consolidation .claude/CLAUDE.md	Removed extensive instructional content about project architecture, build commands, testing, and preferences; replaced with a single directive to avoid unnecessary duplication.
Agent Onboarding Guide AGENTS.md	New documentation file establishing canonical guidance for agents, including high-level library overview, core components (IndexerProcessor, IndexerFactory, IndexerRunner), runtime modes (LogsIndexer, BlockIndexer), mental models, task descriptions, and verification expectations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A rabbit hops through docs with glee,
Old whispers trimmed from CLAUDE's decree,
New AGENTS guide now shines so bright,
Clean guidance paths, a clarion light! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately describes the main change: adding a new AGENTS.md documentation file that serves as a guide for agents working with the indexer-core library.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch agents-file

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

📦 Snapshot Published

org.vechain:indexer-core:pr.113.3758b84-SNAPSHOT

Usage

Add the GitHub Packages repository to your build.gradle.kts:

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/vechain/indexer-core")
        credentials {
            username = findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
            password = findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
        }
    }
}

Then use the dependency:

implementation("org.vechain:indexer-core:pr.113.3758b84-SNAPSHOT")

Note: Requires a GitHub PAT with read:packages scope in ~/.gradle/gradle.properties:

gpr.user=YOUR_GITHUB_USERNAME
gpr.key=ghp_YOUR_TOKEN

[coderabbitai]

🧹 Nitpick comments (1)

AGENTS.md (1)

46-46: Optional: Consider capitalizing "Markdown" as a proper noun.

The static analysis tool suggests "Markdown" should be capitalized as it's a proper noun (the name of a formatting language).

📝 Proposed capitalization fix

-The repo markdown docs are the source of truth. Prefer them over memory, ad hoc code reading, or external copies.
+The repo Markdown docs are the source of truth. Prefer them over memory, ad hoc code reading, or external copies.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` at line 46, Update the phrase "markdown docs" to use the proper
noun capitalization "Markdown" in AGENTS.md so the line reads e.g. "The repo
Markdown docs are the source of truth." — locate the exact sentence containing
"markdown docs" and replace "markdown" with "Markdown" to match the suggested
capitalization.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@AGENTS.md`:
- Line 46: Update the phrase "markdown docs" to use the proper noun
capitalization "Markdown" in AGENTS.md so the line reads e.g. "The repo Markdown
docs are the source of truth." — locate the exact sentence containing "markdown
docs" and replace "markdown" with "Markdown" to match the suggested
capitalization.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 90f64f4d-c654-4cfd-9d14-de1ae3c2b37d

📥 Commits

Reviewing files that changed from the base of the PR and between 9c5bb5e and 3758b84.

📒 Files selected for processing (2)

• .claude/CLAUDE.md
• AGENTS.md