docs: fix all documentation issues

[ajianaz]

Summary

Fixes all documentation inaccuracies across README.md and CONTRIBUTING.md:

README.md (11 fixes)

• Fix .cora.yaml schema to match actual nested struct
• Fix --output → --format flag throughout
• Fix download URLs to match actual release asset naming
• Fix env var case (CORa → CORA)
• Fix CI workflow to download binary, use --base flag, single env block
• Remove non-existent Homebrew tap (mark as planned)
• Fix --severity values (warning → major, etc.)
• Remove non-existent cora config init
• Mark pre-commit.com framework as planned
• Add missing CORA_API_KEY, CORA_BASE_URL, CORA_FORMAT env vars
• Add cora hook command section

CONTRIBUTING.md (4 fixes)

• Update project structure to actual modular layout
• Fix Rust version 1.75 → 1.85
• Remove -s from commit example (no DCO)
• Add CI cora self-review note
• Fix bug report log command (RUST_LOG → cora --verbose)

Summary by CodeRabbit

• Documentation
  • Updated Rust version requirement to 1.85+.
  • Added binary download installation option with platform examples.
  • Introduced cora init command in Quick Start workflow.
  • Updated command examples, configuration structure, and flag documentation.
  • Standardized environment variables to use CORA_* naming convention.
  • Refreshed CI/CD integration guidance for GitHub Actions and GitLab CI.
  • Expanded bug reporting checklist with additional environment details.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c312fa01-d9d9-49a7-b2fb-17281d794244

📥 Commits

Reviewing files that changed from the base of the PR and between 6d4774e and aaef395.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• README.md

---

📝 Walkthrough

Walkthrough

CONTRIBUTING.md and README.md documentation updated to reflect Rust 1.85+ toolchain requirement, refined project structure, new CLI command patterns (cora init, cora review, cora scan), restructured .cora.yaml configuration schema, corrected CORA_* environment variable naming, and revised CI/CD integration guidance for GitHub Actions and GitLab CI.

Changes

Documentation Updates for cora-cli Requirements and CLI Patterns

Layer / File(s)	Summary
Development Requirements and Toolchain CONTRIBUTING.md, README.md	Rust minimum toolchain requirement updated from 1.75+ to 1.85+ in prerequisites and development sections across both files.
Contribution Guidelines and Project Structure CONTRIBUTING.md	Project structure section expanded with granular module layout (commands, config, engine, formatters, git, hook); commit workflow changed from signed commits to standard git commit -m; PR process notes CI automation; bug reporting checklist enhanced with cora --version and cora --verbose review commands.
Installation and Feature Overview README.md	Multi-LLM Support feature explicitly includes Ollama; installation section reorganized to add binary download instructions with platform asset naming guidance, alongside build-from-source option.
Quick Start and Command Examples README.md	Quick start revised to introduce optional cora init step; cora review and cora scan command examples rewritten with updated flags (SARIF --format sarif, --upload, --base origin/main) and severity threshold changes from warning to major.
Configuration Documentation and Schema README.md	Configuration section updated to document cora init and cora config set commands; new .cora.yaml structure documented with provider selection, focus/rules/ignore blocks, hook mode, diff-size limits, and output settings.
Environment Variables and CI/CD Integration README.md	Environment variables table corrected to CORA_* naming convention; GitHub Actions example updated to download platform-specific release tarball and run cora review --base origin/main --upload; GitLab CI and pre-commit hook examples updated to use --severity major; pre-commit framework section replaced with status note.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A rabbit hops through docs so clear,
From Rust one-seventy-five to eighty-five, a cheer!
New cora commands, config files bright,
Environment variables now spelled just right.
Installation flows and CI paths align,
The docs are updated, and all feels fine! 🌟

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/fix-documentation

⚔️ Resolve merge conflicts

• Resolve merge conflict in branch docs/fix-documentation

---

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