Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: updated documentation #82

Merged
merged 1 commit into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/pages/getting_started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,43 @@ Utilize our cloud-hosted, scalable application at [https://beta.cloudcode.ai](ht
Deploy your own instance of the open-source Cloud Code project by following the installation instructions provided in our documentation. Follow the steps outlined in the [installation guide](self_hosting_guide) to set up Cloud Code AI on your infrastructure.

Choose the option that best fits your needs and start accelerating your software development with Cloud Code AI today!

## Getting Started

To get started with Kaizen, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/Cloud-Code-AI/kaizen.git
```

2. Install dependencies:

```bash
cd kaizen
poetry install
```

3. Generate tests for your website:

First, you need to update the URL in the `examples/basic/generate.py`
```bash
PYTHONPATH=. poetry run python examples/basic/generate.py
```

Kaizen will generate all the tests and store them inside `.kaizen/tests/`

4. Execute tests:

Once you have generated all the necessary tests, you can run all the tests in two ways:
```bash
PYTHONPATH=. poetry run python examples/basic/execute.py
```

Or using the default pytest module:
```
pytest -v .kaizen/tests/
```

Kaizen will generate all the tests and store them inside `.kaizen/tests/`
22 changes: 12 additions & 10 deletions docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
Welcome to the Cloud Code AI documentation! This resource will guide you through utilizing Cloud Code AI to enhance your software development journey — from code reviews and testing automation to ensuring the security and reliability of your applications.
Welcome to the Kaizen documentation! This resource will guide you through utilizing Kaizen to enhance your software development journey — from code reviews and testing automation to ensuring the security and reliability of your applications.

## About Cloud Code AI

Cloud Code AI is an AI-driven platform designed to empower development teams by automating critical aspects of the software development lifecycle. Our suite of tools helps streamline code reviews, generate robust test cases, and ensure end-to-end functionality for your applications.
## About Kaizen

Kaizen is an open-source project that helps teams ensure quality in their software delivery by providing a suite of tools for code review, test generation, and end-to-end testing. It integrates with your existing code repositories and workflows, allowing you to streamline your software development process.
## Key Features

- #### Code Review
CloudCode automatically reviews pull requests, summarizing code changes, and providing insightful feedback on potential issues or areas of improvement. It leverages advanced natural language processing techniques to understand the context and implications of the code changes.
### End-to-End Testing

Kaizen generates comprehensive end-to-end tests based on your application's code and documentation. These tests ensure that your application functions correctly from start to finish, catching regressions and edge cases that may have been overlooked during development.

### UI Testing and Review

Kaizen can provide teams with helpful reviews for their UI and generate necessary tests to ensure that their website works as expected.

- #### End-to-End Testing
CloudCode generates comprehensive end-to-end tests based on your application's code and documentation. These tests ensure that your application functions correctly from start to finish, catching regressions and edge cases that may have been overlooked during development.
### Code Review

- #### RAGify
CloudCode RAGifies your code repositories, generating relevant context and allowing you to integrate your own Large Language Models (LLMs) or use pre-trained models. This feature enables you to leverage the power of LLMs for various tasks, such as code generation, documentation, and more. the code review process with AI-driven insights and feedback.
Kaizen automatically reviews pull requests, summarizes code changes and provides insightful feedback on potential issues or areas of improvement. It leverages advanced natural language processing techniques to understand the context and implications of the code changes.
Loading