Skip to content

Commit

Permalink
Fix broken links and update link checking docs (#2327)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
BigLep authored Oct 10, 2024
1 parent 1ffb7bb commit 6354f02
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![MIT License](https://img.shields.io/badge/license-MIT-blueviolet?style=for-the-badge)](https://protocol.ai/blog/announcing-the-permissive-license-stack/)
[![Website status](https://img.shields.io/website.svg?style=for-the-badge&url=https%3A%2F%2Fdocs.filecoin.io)](https://docs.filecoin.io/)
[![Backlog](https://img.shields.io/badge/backlog-Updated-blue?style=for-the-badge)](https://github.com/orgs/filecoin-project/projects/103/views/1)
![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)
[![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)

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

</div>

## Table of contents
## Table of contents <!-- omit in toc -->

- [About this repo](#about-this-repo)
- [Contributing](#contributing)
- [Link checking](#link-checking)
- [Issues](#issues)
- [Backlog](#backlog)
- [Priority](#priority)
- [Backlog](#backlog)
- [Priority](#priority)
- [License](#license)

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

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).

### Link checking

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:
1. wrap it in `` `backquoetes` `` OR
2. wrap it in `<code>` blocks OR
3. use [`.lycheeignore`](https://github.com/lycheeverse/lychee-action?tab=readme-ov-file#excluding-links-from-getting-checked)

## Issues

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!
Expand Down
10 changes: 5 additions & 5 deletions networks/mainnet/rpcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ These endpoints are limited to the read-only [Filecoin JSON RPC API](../../refer

Provider | HTTPS endpoint | WSS endpoint | Docs | API Support
-- | -- | -- | -- | --
[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
[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
[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) |  
[NOWNodes](https://nownodes.io/) | https://fil.nownodes.io (Free for 1 month with signup) |   | [NOWNodes - Docs](https://documenter.getpostman.com/view/13630829/TVmFkLwy) |  
[GetBlock](https://getblock.io/nodes/fil) | https://filecoin.getblock.io (Free with signup) |   | [GetBlock - Docs](https://getblock.io/docs/getblock-explorer/get-started/) |  
[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
[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
[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) |  
[NOWNodes](https://nownodes.io/) | `https://fil.nownodes.io` (Free for 1 month with signup) |   | [NOWNodes - Docs](https://documenter.getpostman.com/view/13630829/TVmFkLwy) |  
[GetBlock](https://getblock.io/nodes/fil) | `https://filecoin.getblock.io` (Free with signup) |   | [GetBlock - Docs](https://getblock.io/docs/getblock-explorer/get-started/) |  

## Additional Notes:

Expand Down
2 changes: 1 addition & 1 deletion nodes/implementations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ Forest is the Rust implementation of the Filecoin protocol with low hardware req

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/).

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/).
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 comments on commit 6354f02

Please sign in to comment.