feat(docs): add documentation index and restructure README for clarity

[daithihearn]

Summary by CodeRabbit

• Documentation

  • Comprehensive documentation overhaul with restructured README, clearer setup instructions, and simplified examples.
  • Expanded guides covering indexer configuration, event handling, business events, and logs indexing.
  • Updated guidance emphasizing simplified, factory-driven configuration over code-heavy setups.

• Chores

  • Version bumped to 8.0.3.
  • Added Docker build configuration to exclude unnecessary artifacts.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bad06ef9-5a23-4c91-acc7-bc79566fc988

📥 Commits

Reviewing files that changed from the base of the PR and between ae61643 and 4a68a66.

📒 Files selected for processing (9)

• .dockerignore
• .gitignore
• README.md
• build.gradle.kts
• docs/BusinessEvents.md
• docs/EventsAndABIHandling.md
• docs/IndexerOverview.md
• docs/LogsIndexerOverview.md
• docs/README.md

---

📝 Walkthrough

Walkthrough

This PR updates Docker and Git configuration files, bumps the project version to 8.0.3, and comprehensively restructures documentation across multiple files. The documentation shifts emphasis from code-heavy examples to factory-driven patterns (IndexerFactory), introduces new runtime types (IndexerProcessor, IndexingResult), and consolidates implementation guidance into a cohesive docs directory structure.

Changes

Cohort / File(s)	Summary
Configuration & Build .dockerignore, .gitignore, build.gradle.kts	Added .dockerignore to exclude development and build artifacts from Docker contexts; updated .gitignore with Local Tooling section for Swift cache; bumped version from 8.0.2 to 8.0.3.
Root Documentation README.md	Replaced feature lists and verbose examples with requirements, installation, and dependency declaration examples; condensed architecture explanation and redirected in-depth guidance to docs directory.
Core Indexer Documentation docs/IndexerOverview.md, docs/LogsIndexerOverview.md	Introduced public runtime types (IndexerProcessor interface, IndexingResult variants: LogResult and BlockResult); restructured from implementation-focused to factory-driven configuration patterns; updated lifecycle and processing narratives.
Event Processing Documentation docs/BusinessEvents.md, docs/EventsAndABIHandling.md	Rewrote from manual/block-centric approaches to IndexerFactory-driven workflows; added comprehensive guidance on business event structure, processing flows, ABI resource loading, placeholder substitution, and VET transfer handling; introduced CombinedEventProcessor concept.
Documentation Structure docs/README.md	Added new docs/README.md with documentation strategy, guides index, and Confluence integration guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Always call process #103: The documentation updates mirror exact API changes including IndexingResult variant renaming (BlockResult/LogResult), new IndexerProcessor.process signature, and removal of pruner-related APIs.

Suggested reviewers

• nawfal-labrahmi

Poem

🐰 Configuration tidied, docs now shine so bright,
New patterns bloom where factories ignite,
From verbose examples to guidance refined,
A cleaner canvas for all who align,
Hop forward we go, version 8.0.3! ✨

🚥 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 title accurately describes the main changes: adding a documentation index (docs/README.md) and restructuring the main README for clarity, which are the primary objectives of this PR.
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 docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch documentation3

---

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.112.4a68a66-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.112.4a68a66-SNAPSHOT")

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

gpr.user=YOUR_GITHUB_USERNAME
gpr.key=ghp_YOUR_TOKEN