Skip to content

Conversation

@Vimal-Shady
Copy link
Contributor

🐛 Fix broken 'Get Started' link in README

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests? (Not applicable here)

What does this PR do?

Fixes #672

🔍 Summary

PR review

This is a simple documentation fix and doesn't affect any logic or codebase functionality.
Community members are welcome to review once the tests pass.

Did you have fun?

Yes, Happy to contribute and help improve the developer experience!

@deependujha
Copy link
Collaborator

deependujha commented Aug 6, 2025

Hi @Vimal-Shady

Can you also add a file in .github/workflows that checks for broken links: https://github.com/Lightning-AI/pytorch-lightning/blob/master/.github/workflows/ci-check-md-links.yml

Should be very similar, just, replace master with main.

@Vimal-Shady
Copy link
Contributor Author

Hi @Vimal-Shady

Can you also add a file in .github/workflows that checks for broken links: https://github.com/Lightning-AI/pytorch-lightning/blob/master/.github/workflows/ci-check-md-links.yml

Should be very similar, just, replace master with main.

Sure I'll update that create a PR for that too

@codecov
Copy link

codecov bot commented Aug 6, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84%. Comparing base (e390deb) to head (377a127).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@         Coverage Diff         @@
##           main   #674   +/-   ##
===================================
- Coverage    84%    84%   -0%     
===================================
  Files        52     52           
  Lines      7143   7143           
===================================
- Hits       5967   5965    -2     
- Misses     1176   1178    +2     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@deependujha deependujha merged commit 21786d1 into Lightning-AI:main Aug 6, 2025
35 checks passed
@deependujha
Copy link
Collaborator

thanks @Vimal-Shady for contributing.

@Vimal-Shady
Copy link
Contributor Author

thanks @Vimal-Shady for contributing.

Thanks and I have a Question I added the yml file but about the json config file can I just add the same link for check or is there some other links that i have to add too. Kindly reply. Thanks!

@Vimal-Shady
Copy link
Contributor Author

Vimal-Shady commented Aug 6, 2025

I have Made a PR #676 kindly review and contact me for further changes and if I need to change or add the markdown-link-config as mentioned in the PR, feel free to contact me if required. Thanks

@bhimrazy
Copy link
Collaborator

bhimrazy commented Aug 7, 2025

Hi @Vimal-Shady,
If you're not already there, pls feel free to join our LitData Discord community — we'd love to have you around!

You're welcome to start any discussions or ask questions in the #litdata channel. Looking forward to collaborating more with you! ⚡

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.

Get started link in README is broken

4 participants