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

Jump to bottom

docs(readme): increase Readme Specificity #523

Merged
merged 7 commits into from
Jul 30, 2024
Merged

docs(readme): increase Readme Specificity #523

merged 7 commits into from
Jul 30, 2024

Conversation

swamu
Copy link
Contributor

@swamu swamu commented Jul 25, 2024

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

  1. Fixed all the links in the readme that were not working
  2. Fixed a few steps by changing order/content
  3. Removed script that had occasional set up issues from just the readme (still in pkg.json for future fixes)

How did you test it?

https://github.com/juspay/hyperswitch-web/tree/swamu/docs-readme-change

Checklist

  • I ran npm run re:build
  • I reviewed submitted code
  • I added unit tests for my changes where possible

@swamu swamu requested a review from akash-c-k as a code owner July 25, 2024 10:27
@swamu swamu requested a review from PritishBudhiraja July 25, 2024 10:52
@swamu swamu self-assigned this Jul 25, 2024
@swamu swamu added the Ready for Review PR with label Ready for Review should only be reviewed. label Jul 25, 2024
vsrivatsa-edinburgh
vsrivatsa-edinburgh reviewed Jul 26, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
vsrivatsa-edinburgh
vsrivatsa-edinburgh reviewed Jul 26, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
vsrivatsa-edinburgh
vsrivatsa-edinburgh reviewed Jul 26, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
PritishBudhiraja
PritishBudhiraja approved these changes Jul 29, 2024
View reviewed changes
Copy link
Collaborator

@PritishBudhiraja PritishBudhiraja left a comment

Choose a reason for hiding this comment

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

LGTM :')

@PritishBudhiraja PritishBudhiraja merged commit a9c1a6e into main Jul 30, 2024
3 checks passed
@PritishBudhiraja PritishBudhiraja deleted the swamu/docs-readme-change branch July 30, 2024 07:18
@github-actions github-actions bot added the Closed Label will be automatically added when the PR will get merged to main label Jul 30, 2024
@PritishBudhiraja PritishBudhiraja removed the Ready for Review PR with label Ready for Review should only be reviewed. label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsrivatsa-edinburgh vsrivatsa-edinburgh vsrivatsa-edinburgh approved these changes

@akash-c-k akash-c-k akash-c-k approved these changes

@PritishBudhiraja PritishBudhiraja PritishBudhiraja approved these changes

Assignees

@swamu swamu

Labels
Closed Label will be automatically added when the PR will get merged to main
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@swamu @PritishBudhiraja @akash-c-k @vsrivatsa-edinburgh