Skip to content

docs: fix links and add link checker #263

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

Open
ayaanoncrypto wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix links and add link checker #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 35 additions & 0 deletions .github/workflows/check-links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Check links

on:
pull_request:
push:
branches:
- main

permissions:
contents: read

jobs:
links:
name: Check repository links
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4

- name: Check Markdown links
uses: lycheeverse/lychee-action@v2.4.0
with:
args: --verbose --no-progress './**/*.md' './**/*.mdx'
fail: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Upload link-checker report
if: always()
uses: actions/upload-artifact@v4
with:
name: link-checker-report
path: lychee-out.md
if-no-files-found: ignore
retention-days: 7
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Click on the packages to view more details.

- **[Website](https://push.org)** To checkout our Product.
- **[Docs](https://push.org/docs)** For comprehensive documentation.
- **[Blog](https://medium.com/push-protocol)** To learn more about our partners, new launches, etc.
- **[Blog](https://push.org/blog)** To learn more about our partners, new launches, etc.
- **[Discord](https://discord.com/invite/pushchain)** for support and discussions with the community and the team.
- **[GitHub](https://github.com/push-protocol)** for source code, project board, issues, and pull requests.
- **[GitHub](https://github.com/pushchain)** for source code, project board, issues, and pull requests.
- **[X/Twitter](https://x.com/pushchain)** for the latest updates on the product and published blogs.

## Contributing
Expand All @@ -56,7 +56,7 @@ Push Protocol is an open source Project. We firmly believe in a completely trans
- Feature Request: Please submit a feature request if you have an idea or discover a capability that would make development simpler and more reliable.
- Documentation Request: If you're reading the Push documentation and believe that we're missing something, please create a docs request.

<!-- Read how you can contribute <a href="https://github.com/push-protocol/push-chain-sdk/blob/main/CONTRIBUTING.md
<!-- Read how you can contribute <a href="https://github.com/pushchain/push-chain-sdk/blob/main/CONTRIBUTING.md
">HERE</a> -->

Not sure where to start? Join our discord and we will help you get started!
Expand Down