Skip to content

📝 Pull Request: Revamp README.md for Better Clarity, Structure & Accessibility #569

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 1 commit into
base: main
Choose a base branch
from

Conversation

Ayushibehera
Copy link

What has changed?

This PR enhances the structure, readability, and accessibility of the README.md file in the Keploy Docs repository.

Summary of changes:

  • Fixed broken link to Keploy Community Forum at line 14

  • Highlighted the main repo's issue tracker with a clickable hyperlink

  • Replaced all improper <br/> tags with Markdown-compliant spacing

  • Reworded unclear sentences and standardized terminology (e.g., NodeJS → Node.js)

  • Added a Table of Contents for easier navigation

  • Corrected the Slack badge label from @layer5 to Keploy

Type of change

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

How Has This Been Tested?

No build-breaking changes introduced. Only README.md was modified.

Checklist:

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

Signed-off-by: Ayushi Behera <146361792+Ayushibehera@users.noreply.github.com>
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

@pratik-mahalle pratik-mahalle left a comment

Choose a reason for hiding this comment

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

Hey @Ayushibehera, Thanks for raising this pr.
Unfortunately, this PR doesn’t include any meaningful changes, typos and breaking links are supposed or just content changes are to be reported not fixed. You can do so on the specific two repositories that we provided. In the future, please ensure that a PR in this repo is raised only if you’ve made substantial updates or solved a particular issue. This helps keep the process efficient and organized.
This being a part of an assignment in api fellowship would be counted since you were suppsoed to create a pr but wont be merged since this is not that relevant of a change. I’m sure you understand, and I appreciate your cooperation on this. We will be closing this PR for now.

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.

2 participants