feat: Add CONTRIBUTING, API, architecture, and modules docs

[dev-dami]

Summary by CodeRabbit

• Documentation
  • Rebranded project from gmi-cli to gim with updated messaging focused on high-performance modular design
  • Added comprehensive documentation suite: contributor guidelines, API reference, architecture overview, extending guide, and modules documentation
  • Reorganized README with improved structure featuring use cases, installation, current capabilities, planned features, and extended usage examples

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request adds comprehensive documentation and updates the project's branding. The README has been reorganized with updated project naming (gmi-cli to gim), restructured sections for features and usage examples, and expanded build instructions. A new CONTRIBUTING.md file provides contributor guidelines and workflows. Five new documentation files have been added under docs/ covering API, architecture, extending, modules, and project index.

Changes

Cohort / File(s)	Summary
Top-level documentation README.md, CONTRIBUTING.md	README rebranded (gmi-cli → gim), restructured with features, usage, and documentation sections; examples expanded. CONTRIBUTING.md added with setup, development workflow, code style, and PR guidelines.
API & Architecture docs docs/api.md, docs/architecture.md, docs/index.md	New documentation files describing the API surface (MetricCollector trait, MetricData, OutputFormat), overall architecture with component separation (CLI, Core, Modules, Output), and project overview with goals and planned features.
Extension & module guides docs/extending.md, docs/modules.md	New documentation covering how to extend the system with new collectors and formats, register modules, add output formats, and best practices. Module architecture, available modules (CPU, memory), and step-by-step guidance for creating new modules included.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• All changes are documentation additions and README reorganization
• No functional code modifications or public API changes
• Homogeneous content across multiple similar documentation files
• Straightforward structural and branding updates

Poem

🐰 Hop, hop! A warren of docs takes flight,
From README to guides, all structured just right,
Contributing paths and API tales told,
Extending and modules—a story unfold'd,
With gim's modular spirit, the future is bright! ✨

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev-dami

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa64321 and 11cc6a4.

📒 Files selected for processing (7)

• CONTRIBUTING.md (1 hunks)
• README.md (2 hunks)
• docs/api.md (1 hunks)
• docs/architecture.md (1 hunks)
• docs/extending.md (1 hunks)
• docs/index.md (1 hunks)
• docs/modules.md (1 hunks)

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

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.}