Skip to content

Commit f005c85

Browse files
committed
refactor: Cleanup Ruby quickstart documentation
- Remove emojis and informal language - Clarify terminal usage for API calls - Standardize headings Signed-off-by: Atul Chahar <chaharatul92@gmail.com>
1 parent 7e1e625 commit f005c85

21 files changed

Lines changed: 231 additions & 18 deletions

pr_description.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Description
2+
This PR adds a new Quickstart guide for **Ruby (Sinatra + PostgreSQL)**.
3+
4+
It includes:
5+
- A new guide: `samples-sinatra-postgres.md`
6+
- Updates to `QuickStartFilter.js` to include Ruby language support.
7+
- Updates to `QuickStartList.js` to list the new quickstart.
8+
- Sidebar updates in `version-4.0.0-sidebars.json`.
9+
- Terminal screenshots for both Docker and local setups.
10+
11+
## Related Issue
12+
Fixes #3521
13+
14+
## Checklist
15+
- [x] Documentation build passes (`npm run build`)
16+
- [x] Added new language to `QuickStartFilter.js`
17+
- [x] Added configuration for the new quickstart in `QuickStartList.js`
18+
- [x] Added screenshots for commands (Record, Test, API calls)
19+
- [x] Verified links and formatting
20+
21+
## Sample Code
22+
The sample application code is available at: [Atul-Chahar/samples-ruby](https://github.com/Atul-Chahar/samples-ruby/tree/master/sinatra-postgres)

src/components/QuickStartFilter.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, { useState } from "react";
22
import quickstarts from "./QuickStartList";
33
import Link from "@docusaurus/Link";
4-
import { FaGolang } from "react-icons/fa6";
4+
import { FaGolang, FaRust } from "react-icons/fa6";
55
import { FaJava, FaLaptopCode, FaDocker, FaPython, FaCheck, FaArrowRight, FaArrowLeft } from "react-icons/fa";
66
import { TbBrandCSharp } from "react-icons/tb";
77
import { DiRuby } from "react-icons/di";
@@ -30,6 +30,7 @@ export default function QuickstartFilter({ defaultLanguage = null }) {
3030
{ name: "JS/TS", icon: <IoLogoJavascript size={24} />, color: "#F7DF1E" },
3131
{ name: "C#", icon: <TbBrandCSharp size={24} />, color: "#512BD4" },
3232
{ name: "Ruby", icon: <DiRuby size={24} />, color: "#CC342D" },
33+
{ name: "Rust", icon: <FaRust size={24} />, color: "#DEA584" },
3334
];
3435

3536
const servers = [

src/components/QuickStartList.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,24 @@ const quickstarts = [
414414
"A sample User CRUD app to demonstrate how seamlessly Keploy integrates with Sinatra and PostgreSQL.",
415415
link: "/docs/quickstart/samples-sinatra-postgres/#running-app-locally-on-linuxwsl-",
416416
},
417+
418+
// Rust list
419+
{
420+
title: "Actix + Postgres",
421+
language: "Rust",
422+
server: "Docker",
423+
description:
424+
"A sample Actix-web app to demonstrate how seamlessly Keploy integrates with Rust and PostgreSQL.",
425+
link: "/docs/quickstart/rust-actix-postgres/#option-1-using-docker-compose-",
426+
},
427+
{
428+
title: "Actix + Postgres",
429+
language: "Rust",
430+
server: "Local",
431+
description:
432+
"A sample Actix-web app to demonstrate how seamlessly Keploy integrates with Rust and PostgreSQL.",
433+
link: "/docs/quickstart/rust-actix-postgres/#option-2-running-locally-",
434+
},
417435
];
418436

419437
export default quickstarts;
77 KB
Loading

static/img/rust-curl-traffic.png

115 KB
Loading

static/img/rust-docker-up.png

51.9 KB
Loading
141 KB
Loading

static/img/rust-local-curl.png

118 KB
Loading

static/img/rust-local-db-up.png

93.6 KB
Loading

static/img/rust-local-db.png

96.2 KB
Loading

0 commit comments

Comments
 (0)