Skip to content

Comments

Redesign README to look product-grade#9

Merged
malinosqui merged 2 commits intomainfrom
docs/readme-redesign
Feb 22, 2026
Merged

Redesign README to look product-grade#9
malinosqui merged 2 commits intomainfrom
docs/readme-redesign

Conversation

@malinosqui
Copy link
Member

@malinosqui malinosqui commented Feb 22, 2026

Summary

  • Restructure README from project doc into product page with centered header, badges, and quick install
  • Lead with "What It Does" section covering the 3 core capabilities: Code Review, PR Suggestions, Decision Memory
  • Highlight AI agent integration as the primary use case with skill installer (review-skill.com) and per-agent setup guides
  • Rewrite Authentication section with clear distinction between trial, personal login, team key (for large teams), and CI/CD token
  • Add Privacy & Security section for trust
  • Use collapsible <details> sections for flags, env vars, and install methods to keep the page scannable
  • Add <!-- TODO --> placeholders for banner image and demo GIF (design team follow-up)

What changed

Before After
Plain text title Centered header + badge row + nav links
Feature list buried mid-page "What It Does" with 3 capabilities at the top
AI agent section as one of many Primary use case with skill install + setup guides
Auth as 4 commands 4 distinct auth methods with use cases explained
No privacy section Privacy & Security section
Everything inline Collapsible sections for detail

Test plan

  • Preview rendered README on GitHub (check badges, collapsible sections, anchor links)
  • Verify install commands are correct (npm install -g @kodus/cli, npx @kodus/cli review, curl, skill installer)
  • Check all links resolve (kodus.io, app.kodus.io, review-skill.com, GitHub issues)
  • Confirm <details> sections expand/collapse correctly on GitHub

🤖 Generated with Claude Code


This pull request significantly redesigns the README.md to present a more product-grade and user-friendly overview of the Kodus CLI.

Key changes include:

  • Enhanced Presentation: Added a centered title, a clear tagline, and various badges (npm version, downloads, license, stars, Node.js version) along with quick links to the website, sign-up, and issues.
  • Streamlined Quick Start: Simplified the initial setup process into three clear steps: install, authenticate, and review.
  • Expanded Feature Set: Introduced new sections detailing core functionalities:
    • Code Review: Emphasizes context-aware reviews using project-specific rules.
    • PR Suggestions: Highlights the ability to fetch AI-powered suggestions for open pull requests directly from the terminal.
    • Decision Memory: Introduces a new system to capture AI agent decisions and reasoning into versioned markdown files within the repository.
  • Stronger AI Agent Integration: Dedicated a new section to explain how Kodus CLI works best with AI coding agents (e.g., Claude Code, Cursor, Windsurf), including a recommended "Skill installer" for seamless setup and detailed configuration examples.
  • Comprehensive Installation Guide: Reorganized installation instructions, prioritizing the new "Skill installer" and placing other methods (npm, npx, curl, Homebrew) into collapsible sections.
  • Detailed Review Modes: Provided clearer explanations for Interactive, Auto-fix, and AI Agent review modes, along with comprehensive lists of output formats, diff targets, and flags in a collapsible section.
  • CI/CD and Git Hooks: Added a new section outlining how to use Kodus CLI with pre-push hooks and in CI/CD pipelines for automated checks and report generation.
  • Refined Authentication: Expanded the authentication section to cover Trial Mode, Personal Login, Team Keys (recommended for AI agents and shared environments), and CI/CD Tokens.
  • Privacy & Security: Introduced a new section detailing Kodus's commitment to data privacy and security.
  • Contributing Guidelines: Added a basic section for contributors.
  • Removed Verbose Logging Warning: The prominent security warning regarding KODUS_VERBOSE has been removed, and the environment variables section has been condensed.

malinosqui and others added 2 commits February 22, 2026 10:32
Restructure the README from a project doc into a product page:
- Add centered header with badges (npm, downloads, license, stars, node)
- Lead with "What It Does" section: Code Review, PR Suggestions, Decision Memory
- Highlight AI agent integration as the primary use case with skill installer
- Add per-agent setup guides (Claude Code, Cursor, Windsurf)
- Rewrite auth section with clear distinction between trial, personal, team key, and CI/CD token
- Add Privacy & Security section
- Use collapsible sections for detailed flags and env vars
- Recommend Kodus platform for CI/CD PR reviews instead of CLI

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kody-ai
Copy link

kody-ai bot commented Feb 22, 2026

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.

  • Validate Business Logic: Ask Kody to validate your code against business rules by adding a comment with the @kody -v business-logic command.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug
Performance
Security
Cross File

Access your configuration settings here.

@malinosqui malinosqui merged commit ede6830 into main Feb 22, 2026
4 checks passed
@kody-ai
Copy link

kody-ai bot commented Feb 22, 2026

kody code-review Kody Rules critical

This PR updates documentation related to environment variables (KODUS_API_URL, KODUS_VERBOSE, KODUS_TOKEN, KODUS_TEAM_KEY). Please notify @Wellington01 to verify if any configuration updates are needed for the self-hosted environment. Kody Rule violation: Verificar atualizações de variáveis de ambiente

@kody-ai
Copy link

kody-ai bot commented Feb 22, 2026

kody code-review Kody Rules critical

The pull request description does not contain a reference to a GitHub issue using a closing keyword (e.g., 'Closes #123', 'Fixes #456'). Please update the description to link this PR to the relevant issue. Kody Rule violation: Ensure PR closes referenced issues

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