Skip to content

docs: added quickstart guide for S3-Keploy #564

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

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

Conversation

kpriyanshu2003
Copy link

What has changed?

  1. Ran npx prettier --write '**/*.{js,md}' for formatting
  2. Added docs in quick-start guide for S3-Keploy was missing.

This PR Resolves #2165

Type of change

Please delete options that are not relevant.

  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

Yes, I have tested for the changes

  • npm run build was successful
  • Changes are visible as per expectations on the local build

Before:
image

After:
image
image

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

@Copilot Copilot AI review requested due to automatic review settings June 18, 2025 17:39
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you and congratulations 🎉 for opening your very first pull request in keploy

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation for the new S3-Keploy quickstart sample and updates the site configuration accordingly.

  • Included the S3-Keploy sample in the versioned sidebar
  • Added a new MDX quickstart guide for Go Fiber + AWS S3 integration
  • Cleaned up formatting and style in STYLE.md and README.md

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
versioned_sidebars/version-3.0.0-sidebars.json Added "quickstart/samples-s3-keploy" to sidebar list
versioned_docs/version-3.0.0/quickstart/samples-go-fiber-s3.md New tutorial page for the Fiber + S3 sample
STYLE.md Minor formatting and list-style corrections
README.md Removed an extraneous blank line
Comments suppressed due to low confidence (2)

versioned_docs/version-3.0.0/quickstart/samples-go-fiber-s3.md:14

  • The frontmatter key keyword should be keywords to match other docs and ensure proper indexing.
keyword:

versioned_docs/version-3.0.0/quickstart/samples-go-fiber-s3.md:24

  • [nitpick] Consider toning down informal language and emojis in the introduction to maintain a professional and consistent documentation style.
🪄 Dive into the world of cloud storage management and see how seamlessly Keploy integrates with Fiber and AWS S3! Buckle up, it's gonna be a fun ride! 🎢

@kpriyanshu2003 kpriyanshu2003 changed the title S3 keploy docs: added quickstart guide for S3-Keploy Jun 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs]: add S3 sample app on documentation website
1 participant