Skip to content

docs: add quickstart, preview, and contributor guide improvements #566

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

Closed
wants to merge 1 commit into from
Closed

docs: add quickstart, preview, and contributor guide improvements #566

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ 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/`.


## 👥 Who is This For?

- 📚 Contributors looking to improve Keploy Docs
- 👨‍💻 Developers setting up Keploy in their systems
- 🚀 Tech writers and DevRel folks exploring open source workflows



## 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 @@ -179,7 +187,19 @@ 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).
## 🛠 How to Contribute

We ❤️ open source contributors! Here's how you can contribute:

1. 🍴 Fork this repo
2. 🌿 Create your branch: `git checkout -b your-name-docs`
3. 📝 Make changes (typo fix, new section, formatting...)
4. ✅ Run `npm run build` to verify
5. 🚀 Open a PR with a clear title and description

📌 Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) and [STYLE.md](./STYLE.md) before submitting.

Our planned features can be found on our [Issue Tracker](https://github.com/keploy/keploy/issues/new/choose).

## Community Support ❤️

Expand Down