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.

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

feat: revamp docs #483

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat: revamp docs #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a98b504
feat: update slack urls
Sonichigo Sep 6, 2024
533988e
Merge branch 'main' of https://github.com/sonichigo/keploy-docs
Sonichigo Nov 11, 2024
aacca9f
feat: revamp docs
Sonichigo Dec 27, 2024
be5f389
feat: based on feedback iteration 1
Sonichigo Dec 31, 2024
420f280
feat: based on feedback iteration 2
Sonichigo Jan 2, 2025
2dc2232
feat: based on feedback iteration 2
Sonichigo Jan 2, 2025
98478ba
Merge branch 'main' into main
Sonichigo Jan 2, 2025
c57fd92
Merge branch 'main' of https://github.com/sonichigo/keploy-docs
Sonichigo Jan 3, 2025
901b2ff
feat: final revamp
Sonichigo Jan 3, 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
29 changes: 24 additions & 5 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ module.exports = {
{
to: "/server/installation",
activeBasePath: "none",
label: "Installation",
label: "Getting Started",
},
// {
// to: "/server/installation/",
Expand All @@ -136,12 +136,26 @@ module.exports = {
// label: "test SDKs",
// },
{
to: "/keploy-explained/contribution-guide",
label: "Contribution Guide",
to: "/keploy-cloud/cloud-installation",
label: "Enterprise",
activeBasePath: "none",
},
{
to: "https://keploy.io/blog",
label: "Blog",
label: "Resources",
items: [
{
label: "Blogs",
href: "https://keploy.io/blog",
},
{
label: "Contributing",
href: "/keploy-explained/contribution-guide",
},
{
label: "Glossary",
href: "/concepts/reference/glossary/",
},
],
},
{
type: "docsVersionDropdown",
Expand All @@ -154,6 +168,11 @@ module.exports = {
className: "header-github-link",
"aria-label": "GitHub repository",
},
{
href: "https://app.keploy.io/pricing",
position: "right",
label: "Pricing",
},
// TODO : Add Blogging Section
// {
// to: "/blog",
Expand Down
5 changes: 2 additions & 3 deletions src/components/Community.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ export const Community = () => {
>
<svg
fill="currentColor"
// Hotfix: add viewBox to prevent icon from being cut off after tailwind preflight disabled
className="h-12 w-12 flex-none text-red-500 "
className="h-12 w-12 flex-none text-red-500"
viewBox="0 0 48 48"
>
<rect width="48" height="48" rx="12" />
Expand Down Expand Up @@ -120,7 +119,7 @@ export const Community = () => {
>
<svg
fill="currentColor"
className="h-12 w-12 flex-none text-black"
className="h-12 w-12 flex-none text-black"
viewBox="0 0 512 509.64"
>
<rect width="509.64" height="512" rx="120" />
Expand Down
10 changes: 5 additions & 5 deletions src/components/GitTogether.js → src/components/DevScribe.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ export const GitTogether = () => {
return (
<section className="mb-14 mt-1">
<h2 className="mt-8 text-2xl font-semibold tracking-wide md:text-3xl">
Attend GitTogether
Attend DevScribe
</h2>
<a href="https://keploy.io/gittogether">
<a href="https://keploy.io/devscribe">
<img
className="mt-8 "
src="/docs/img/GitTogether.jpg"
alt={"GitTogether Image"}
className="mt-8"
src="/docs/img/Devscribe.png"
alt={"DevScribe Image"}
/>
</a>
<div className="mt-8 grid grid-cols-1 gap-5 md:grid-cols-2">
Expand Down
86 changes: 48 additions & 38 deletions src/components/Intro.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,86 +27,86 @@ function Languages() {
fill="currentColor"
/>
</svg>
<h2 className="mb-4 text-xl font-semibold">Languages</h2>
<h2 className="mb-4 text-xl font-semibold">QuickStart</h2>
</div>
<ul className="grid grid-cols-3 gap-3 md:grid-cols-3 lg:gap-5">
{/* <ul className="grid grid-cols-2 gap-6 xl:gap-8"> */}
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
className="flex flex-col items-center space-x-3 p-6 hover:underline"
className="hover-label-container flex flex-col items-center space-x-3 p-6 hover:underline"
to={useBaseUrl("/quickstart/samples-gin")}
data-tooltip="Golang"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/golang.svg"
alt="Go lang logo"
alt="Golang logo"
/>
<p className="font-semibold">Go</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
className="flex flex-col items-center space-x-3 p-6 hover:underline"
className="hover-label-container flex flex-col items-center space-x-3 p-6 hover:underline"
to={useBaseUrl("/quickstart/samples-java")}
data-tooltip="Java"
>
<img
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/java.svg"
alt="Java logo"
/>
<p className="font-semibold">Java</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
className="flex flex-col items-center space-x-3 p-6 hover:underline"
className="hover-label-container flex flex-col items-center space-x-3 p-6 hover:underline"
to={useBaseUrl("/quickstart/samples-django")}
data-tooltip="Python"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/python.svg"
alt="Python logo"
/>
<p className="font-semibold">Python</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
className="flex flex-col items-center space-x-3 p-6 hover:underline"
className="hover-label-container flex flex-col items-center space-x-3 p-6 hover:underline"
to={useBaseUrl("/quickstart/samples-nodejs")}
data-tooltip="Javascript"
>
<img
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/javascript-logo.svg"
alt="Javascript logo"
/>
<p className="font-semibold">Javascript</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
className="flex flex-col items-center space-x-3 p-6 hover:underline"
className="hover-label-container flex flex-col items-center space-x-3 p-6 hover:underline"
to={useBaseUrl("/quickstart/samples-rust")}
data-tooltip="Rust"
>
<img
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/rust-logo.svg"
alt="Javascript logo"
/>
<p className="font-semibold">Rust</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
className="flex flex-col items-center space-x-3 p-6 hover:underline"
className="hover-label-container flex flex-col items-center space-x-3 p-6 hover:underline"
to={useBaseUrl("/quickstart/samples-csharp")}
data-tooltip="CSharp"
>
<img
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/csharp-logo.svg"
alt="Javascript logo"
/>
<p className="font-semibold">CSharp</p>
</Link>
</li>
</ul>
Expand All @@ -116,7 +116,7 @@ function Languages() {

function Frameworks() {
return (
<div className="flex flex-col rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg hover:shadow-[color:var(--ifm-card-shadow-color)]">
<div className="flex flex-col rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg">
<div className="flex items-center space-x-4">
<svg
className="mb-4 h-10 w-10 rounded-lg bg-[color:var(--ifm-color)] p-2 text-[color:var(--ifm-background-color)]"
Expand All @@ -135,77 +135,81 @@ function Frameworks() {
</svg>
<h2 className="mb-4 text-xl font-semibold">Dependencies Support</h2>
</div>
<ul className="grid grid-cols-3 gap-3 lg:gap-5">
<ul className="grid grid-cols-3 gap-3 lg:gap-5">
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
to={useBaseUrl("/dependencies/mongo")}
className="flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
data-tooltip="MongoDB"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/mongodb-logo.svg"
alt="Docker logo"
/>
<p className="font-semibold">MongoDB</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
to={useBaseUrl("/dependencies/http")}
className="flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
data-tooltip="HTTP"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/http-logo.svg"
alt="HTTP logo"
/>
<p className="font-semibold">HTTP</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
to={useBaseUrl("/dependencies/postgres")}
className="flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
data-tooltip="PostgreSQL"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/postgres-logo.svg"
alt="PostgresSQL logo"
/>
<p className="font-semibold">PostgresSQL</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link
to={useBaseUrl("/dependencies/redis")}
className="flex flex-col items-center justify-center space-y-1 p-6 text-center "
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline"
data-tooltip="Redis"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/redis-logo.svg"
alt="Redis logo"
/>
<p className="font-semibold">Redis</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link className="flex flex-col items-center justify-center space-y-1 p-6 text-center ">
<Link
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center "
data-tooltip="MySQL"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/mysql-logo.svg"
alt="MySQL logo"
/>
<p className="font-semibold">MySQL</p>
</Link>
</li>
<li className="mt-5 flex flex-col space-y-3 text-lg">
<Link className="flex flex-col items-center justify-center space-y-1 p-6 text-center ">
<Link
className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center "
data-tooltip="DynamoDB"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/dynamodb-logo.svg"
alt="DynamoDB logo"
/>
<p className="font-semibold">DynamoDB</p>
</Link>
</li>
{/*<li className="mt-5 flex flex-col space-y-3 text-lg">*/}
Expand All @@ -227,9 +231,15 @@ export const Intro = () => {
return (
<section className="mb-4 mt-12">
<h2 className="mb-4 text-2xl font-semibold tracking-wide md:text-3xl">
Supports
Getting Started ✨
</h2>
<div className="grid gap-6 sm:grid-cols-2 xl:gap-8">
<p className="text-l text-gray-500">
Get up and running with Keploy in just a few minutes by integrating it
with your applications. Below are the quick-start guides for popular
languages and frameworks.
</p>
<br />
<div className="grid gap-6 sm:grid-cols-2 xl:gap-8">
<Languages />
<Frameworks />
</div>
Expand Down
2 changes: 1 addition & 1 deletion src/components/KeployCloud.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading