Skip to content

docs: added beginner tip for keploy gen verbose flag #541

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+9 −6
Open

docs: added beginner tip for keploy gen verbose flag #541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a6cf06
docs: added beginner tip for keploy gen verbose flag
Dur-jaya Jun 17, 2025
a11e27f
Merge branch 'main' into durjaya-beginner-tip
nehagup Jun 18, 2025
7d14ae7
docs: add beginner tip for keploy gen verbose flag
Dur-jaya Jun 18, 2025
a52b119
Update README.md
Dur-jaya Jun 18, 2025
f731423
Merge branch 'main' into durjaya-beginner-tip
Dur-jaya Jun 18, 2025
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
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Repository for the Keploy documentation website.
</p>
</div>

> ⚠️ **Note:** Issue creation is disabled in this repository.
> To submit a new issue, please visit the [Keploy community forum](https://github.com/keploy/dashboard/issues) or the main repo’s issue tracker.
**Note** :- Issue Creation is disabled on this Repository, please visit [here](https://github.com/keploy/keploy/issues/new/choose) to submit Issue.

<p align="center">
<a href="https://github.com/keploy/docs" alt="GitHub contributors">
Expand Down Expand Up @@ -54,7 +53,7 @@ We use a variety of technologies to build the web interface and support the comm
- [Yarn package manager](https://yarnpkg.com/)
- [React](https://reactjs.org/)
- [GitHub Actions](https://github.com/features/actions)
- [Docusaurus](https://docusaurus.io/)
- Docusaurus

We use NodeJS and Yarn to install, test, and build the website. Docusaurus has been used as a static site generator to build the website. React is being utilized to build our custom component-based user interface to provide a modern look to the website. GitHub Actions manages our CI/CD pipelines and issue triage.

Expand All @@ -76,9 +75,6 @@ npm start

The command starts a local development server and opens a browser window.

> 💡 **Tip:** After running `npm install`, use `npm start` to preview changes live at `http://localhost:3000/`.


## Running Vale Locally for Documentation Linting

To help maintain consistency in our documentation, we use Vale, a syntax-aware linter that checks for spelling, grammar, and style issues.
Expand Down Expand Up @@ -180,6 +176,12 @@ When we merge your PR, a new build automatically occurs and your changes publish
## How to Get Involved?

Keploy welcomes contributions to the docs website. If you have an idea for a new feature or a bug fix, please submit an issue or pull request. Our planned features can be found on our [Issue Tracker](https://github.com/keploy/keploy/issues/new/choose).
### keploy gen

Generates unit tests using the LLM and coverage report.

> **Beginner Tip:** Use the `--verbose` flag with the `keploy gen` command to get detailed logs during unit test generation. This helps understand what Keploy is doing step-by-step and is super helpful for debugging!


## Community Support ❤️

Expand Down
1 change: 1 addition & 0 deletions filename.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> 💡 **Beginner Tip:** Use the `--verbose` flag with the `keploy gen` command to get detailed logs during unit test generation. This helps understand what Keploy is doing step-by-step and is super helpful for debugging!
Loading