Skip to content

Commit 6354f02

Browse files
authored
Fix broken links and update link checking docs (#2327)
* Fix broken links and update link checking docs This is done in support of #2319 * Fixups after viewing on github and preview site * Update README.md
1 parent 1ffb7bb commit 6354f02

File tree

3 files changed

+18
-10
lines changed

3 files changed

+18
-10
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![MIT License](https://img.shields.io/badge/license-MIT-blueviolet?style=for-the-badge)](https://protocol.ai/blog/announcing-the-permissive-license-stack/)
44
[![Website status](https://img.shields.io/website.svg?style=for-the-badge&url=https%3A%2F%2Fdocs.filecoin.io)](https://docs.filecoin.io/)
55
[![Backlog](https://img.shields.io/badge/backlog-Updated-blue?style=for-the-badge)](https://github.com/orgs/filecoin-project/projects/103/views/1)
6-
![Link Checker](https://img.shields.io/github/actions/workflow/status/filecoin-project/filecoin-docs/check-external-links.yml?style=for-the-badge&label=External%20link%20checker)
6+
[![Check Links](https://img.shields.io/github/actions/workflow/status/filecoin-project/filecoin-docs/check-external-links.yml?style=for-the-badge&label=External%20link%20checker)](https://github.com/filecoin-project/filecoin-docs/actions/workflows/check-external-links.yml)
77

88
<picture align=center>
99
<source media="(prefers-color-scheme: dark)" srcset="https://bafybeiaqdbd5zbl55x5vjmkwpjhqapt3ks3q4ykaclqkajhsdwyzlbz3g4.ipfs.w3s.link/Filecoin-logo-blue-white.svg">
@@ -13,13 +13,14 @@
1313

1414
</div>
1515

16-
## Table of contents
16+
## Table of contents <!-- omit in toc -->
1717

1818
- [About this repo](#about-this-repo)
1919
- [Contributing](#contributing)
20+
- [Link checking](#link-checking)
2021
- [Issues](#issues)
21-
- [Backlog](#backlog)
22-
- [Priority](#priority)
22+
- [Backlog](#backlog)
23+
- [Priority](#priority)
2324
- [License](#license)
2425

2526
## About this repo
@@ -30,6 +31,13 @@ This repository manages the documentation for the [Filecoin network](https://fil
3031

3132
Want to help out? Pull requests (PRs) are always welcome! If you want to help out but aren't sure where to start, check out the [issues board](https://github.com/filecoin-project/filecoin-docs/issues).
3233

34+
### Link checking
35+
36+
Links are checked using [lychee-action](https://github.com/lycheeverse/lychee-action) as confirugred by [check-external-links.yml](.github/workflows/check-external-links.yml). Working links are required before merging. If you have a link that should be excluded from checking:
37+
1. wrap it in `` `backquoetes` `` OR
38+
2. wrap it in `<code>` blocks OR
39+
3. use [`.lycheeignore`](https://github.com/lycheeverse/lychee-action?tab=readme-ov-file#excluding-links-from-getting-checked)
40+
3341
## Issues
3442

3543
Found a problem with the Filecoin docs site? [Please raise an issue](https://github.com/filecoin-project/filecoin-docs/issues/new). Be as specific and descriptive as possible; screenshots help!

networks/mainnet/rpcs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ These endpoints are limited to the read-only [Filecoin JSON RPC API](../../refer
1212

1313
Provider | HTTPS endpoint | WSS endpoint | Docs | API Support
1414
-- | -- | -- | -- | --
15-
[Glif Nodes](https://api.node.glif.io/) | https://api.node.glif.io/rpc/v1 | wss://wss.node.glif.io/apigw/lotus/rpc/v1 | [Glif Nodes - Docs](https://api.node.glif.io/) | All Filecoin and Eth JSON RPC methods including MPoolPush
16-
[Ankr](https://ankr.com/) | https://rpc.ankr.com/filecoin | By request at: https://www.ankr.com/rpc/filecoin | [Ankr Docs - Filecoin](https://www.ankr.com/docs/rpc-service/chains/chains-list/#filecoin) | All Filecoin and Eth JSON RPC methods including MPoolPush
17-
[Chainup Cloud](https://cloud.chainup.com/) | https://filecoin.chainup.net/rpc/v1 | wss://filecoin.chainup.net/rpc/v1 | [Chainup Cloud Docs - Filecoin](https://docs.chainupcloud.com/blockchain-api/filecoin/public-apis) |  
18-
[NOWNodes](https://nownodes.io/) | https://fil.nownodes.io (Free for 1 month with signup) |   | [NOWNodes - Docs](https://documenter.getpostman.com/view/13630829/TVmFkLwy) |  
19-
[GetBlock](https://getblock.io/nodes/fil) | https://filecoin.getblock.io (Free with signup) |   | [GetBlock - Docs](https://getblock.io/docs/getblock-explorer/get-started/) |  
15+
[Glif Nodes](https://api.node.glif.io/) | `https://api.node.glif.io/rpc/v1` | `wss://wss.node.glif.io/apigw/lotus/rpc/v1` | [Glif Nodes - Docs](https://api.node.glif.io/) | All Filecoin and Eth JSON RPC methods including MPoolPush
16+
[Ankr](https://ankr.com/) | `https://rpc.ankr.com/filecoin` | By request at: https://www.ankr.com/rpc/filecoin | [Ankr Docs - Filecoin](https://www.ankr.com/docs/rpc-service/chains/chains-list/#filecoin) | All Filecoin and Eth JSON RPC methods including MPoolPush
17+
[Chainup Cloud](https://cloud.chainup.com/) | `https://filecoin.chainup.net/rpc/v1` | `wss://filecoin.chainup.net/rpc/v1` | [Chainup Cloud Docs - Filecoin](https://docs.chainupcloud.com/blockchain-api/filecoin/public-apis) |  
18+
[NOWNodes](https://nownodes.io/) | `https://fil.nownodes.io` (Free for 1 month with signup) |   | [NOWNodes - Docs](https://documenter.getpostman.com/view/13630829/TVmFkLwy) |  
19+
[GetBlock](https://getblock.io/nodes/fil) | `https://filecoin.getblock.io` (Free with signup) |   | [GetBlock - Docs](https://getblock.io/docs/getblock-explorer/get-started/) |  
2020

2121
## Additional Notes:
2222

nodes/implementations/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ Forest is the Rust implementation of the Filecoin protocol with low hardware req
5353

5454
Forest is currently used for generating up-to-date snapshots and managing archival copies of the Filecoin blockchain. Currently, the Forest team is hosting the entire Filecoin archival data for the community to use. This can be downloaded for free [here](https://forest-archive.chainsafe.dev/list/).
5555

56-
You can find the [Forest codebase on GitHub](https://github.com/ChainSafe/forest) and the documentation site at [`chainsafe.github.io/forest`](https://chainsafe.github.io/forest/).
56+
You can learn more about Forest at the [codebase on GitHub](https://github.com/ChainSafe/forest) and [documentation site](https://docs.forest.chainsafe.io/).

0 commit comments

Comments
 (0)