readme cleaning

[mrT23]

PR Type

documentation

---

Description

• Simplified the README.md by removing detailed instructions and linking to new documentation files for development and repo coverage.
• Added docs/development.md with comprehensive instructions for setting up the development environment, running tests, and building the binary.
• Introduced docs/repo_coverage.md to document a new mode for scanning an entire repository, with detailed usage instructions and configuration options.
• Updated company name references from CodiumAI to QodoAI in the documentation.

---

Changes walkthrough 📝

Relevant files

Documentation

README.md Simplify README by linking to detailed documentation          README.md Removed detailed instructions for running the Cover Agent. Added links to new documentation files for development and repo coverage. Updated company name from CodiumAI to QodoAI. +4/-132  development.md Add detailed development setup and contribution guide        docs/development.md Added detailed instructions for setting up the development environment. Included steps for running tests and the app locally. Provided instructions for building the binary locally. +47/-0    repo_coverage.md Document new repo scanning mode and usage instructions      docs/repo_coverage.md Introduced a new mode for scanning an entire repository. Provided step-by-step instructions for running the Cover Agent. Included additional configuration options for test analysis. +49/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 Security concerns Sensitive information exposure: The repo_coverage.md file includes placeholders for AWS credentials (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY) in the example command. While these are just placeholders, it's recommended to use environment variables or configuration files loaded securely rather than showing credential placeholders directly in documentation.

⚡ Recommended focus areas for review Outdated Reference The installation command still references the old CodiumAI GitHub repo URL which should be updated to QodoAI

[codiumai-pr-agent-pro]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	Update repository URL to reflect the current organization name The GitHub repository URL in the installation command still references CodiumAI instead of QodoAI. Update it to use the correct organization name for consistency. docs/repo_coverage.md [6] -1) Install cover-agent on your existing project venv: `pip install git+https://github.com/Codium-ai/cover-agent.git` +1) Install cover-agent on your existing project venv: `pip install git+https://github.com/Qodo-ai/cover-agent.git` Apply this suggestion Suggestion importance[1-10]: 8 Why: This is an important consistency fix as the repository URL needs to match the company's rebranding from CodiumAI to QodoAI. An incorrect URL would cause installation failures for users.	8

💡 Need additional feedback ? start a PR chat