Fix docs/potential-cand link checker failures#56
Merged
Conversation
✅ Deploy Preview for timely-kataifi-9f3a09 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Updates documentation links on docs/potential-cand to pass CI link checking by replacing production self-links with relative links, correcting repo-local paths, and removing/rewriting dead external links.
Changes:
- Converted many
https://docs.filecoin.io/...self-links to relative file links or in-page anchors. - Fixed several broken repo-local paths (including assets and cookbook links).
- Removed/rewrote dead external links (e.g., Saturn) and normalized “Was this page helpful?” feedback URLs.
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| WELCOME.md | Fixes a broken storage-provider entry link in the landing cards table. |
| storage-providers/pdp/install-and-run-pdp.md | Converts faucet reference to a repo-relative doc link. |
| storage-providers/nodes/lite-nodes/spin-up-a-lite-node.md | Replaces production self-links with in-page anchors. |
| storage-providers/nodes/full-nodes/node-providers.md | Replaces a self-link with a direct link to the Mainnet RPCs doc. |
| reference/general/README.md | Updates internal references to local doc files instead of production URLs. |
| reference/exchanges/exchange-integration.md | Converts “Block Explorers” link to a repo-relative doc link. |
| reference/built-in-actors/README.md | Replaces production anchor links with in-page anchors; updates dev guide link. |
| networks-and-tools/networks/mainnet/rpcs.md | Converts lite-node reference to a repo-relative link; fixes feedback URL. |
| networks-and-tools/networks/local-testnet/README.md | Replaces production self-links with in-page anchors. |
| networks-and-tools/assets/transfer-fil.md | Replaces production anchors with in-page anchors; adds explicit IDs for nonstandard headings. |
| networks-and-tools/assets/metamask-setup.md | Converts transfer-fil cross-link to a relative file link. |
| legacy/smart-contracts/programmatic-storage/ccdb.md | Fixes broken asset path to .gitbook/assets/CCDB.gif. |
| legacy/projects/saturn.md | Removes dead saturn.tech links and replaces with archival context text. |
| getting-started/interplanetary-consensus.md | Converts production links to repo-relative doc links. |
| getting-started/how-storage-works/README.md | Converts section links to local relative doc links. |
| getting-started/how-storage-works/filecoin-plus.md | Converts multiple production links to repo-relative doc links. |
| getting-started/how-storage-works/filecoin-and-ipfs.md | Converts community link to a repo-relative doc link. |
| getting-started/how-retrieval-works/basic-retrieval.md | Attempts to replace a production anchor link with an in-page anchor. |
| core-concepts/filecoin-virtual-machine/proofs.md | Converts multiple production anchors to in-page anchors / repo-relative links. |
| core-concepts/filecoin-evm-runtime/difference-with-ethereum.md | Fixes “Was this page helpful?” URL to Airtable feedback form. |
| build/developing-contracts/README.md | Converts all section cross-links to repo-relative doc links. |
| build/developing-contracts/get-test-tokens.md | Converts local-testnet / metamask references to repo-relative doc links. |
| build/developing-contracts/call-built-in-actors.md | Converts internal step links from production URLs to in-page anchors. |
| build/cookbook/README.md | Fixes cookbook card link to point at the actual store-data.md file. |
| build/advanced/multisig.md | Converts multiple production links to repo-relative doc links. |
| build/advanced/fevm-indexers.md | Converts multiple production links to repo-relative doc links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Make sure that you have [Go](https://go.dev/) installed and that your `GOPATH` is set up. By default, your `GOPATH` will be set to `~/go`.\ | ||
| **Install Lassie** [**#**](https://docs.filecoin.io/getting-started/how-retrieval-works/basic-retrieval/#install-lassie) | ||
| **Install Lassie** [**#**](#retrieve-using-lassie) |
There was a problem hiding this comment.
The in-page link labeled “Install Lassie” points to #retrieve-using-lassie, which anchors to the current subsection rather than an “Install Lassie” section. This looks like a broken/incorrect anchor (the previous anchor was #install-lassie). Update the link target to the actual heading ID for the install instructions (or add a matching heading/anchor).
| ``` | ||
|
|
||
| If you want to manage your local testnet tokens in MetaMask you will need to create a `t4` address. You can create a `t4` address using `lotus wallet new deleated`. Once you have a `t4` address you can [connect MetaMask to your local testnet](https://docs.filecoin.io/networks-and-tools/assets/metamask-setup/) to see the new balance within the MetaMask extension. | ||
| If you want to manage your local testnet tokens in MetaMask you will need to create a `t4` address. You can create a `t4` address using `lotus wallet new deleated`. Once you have a `t4` address you can [connect MetaMask to your local testnet](../../networks-and-tools/assets/metamask-setup.md) to see the new balance within the MetaMask extension. |
There was a problem hiding this comment.
The command in the inline code sample uses lotus wallet new deleated, which appears to be a typo; the Lotus subcommand is delegated. As written, users will get an “unknown address type”/usage error. Correct the subcommand spelling.
Suggested change
| If you want to manage your local testnet tokens in MetaMask you will need to create a `t4` address. You can create a `t4` address using `lotus wallet new deleated`. Once you have a `t4` address you can [connect MetaMask to your local testnet](../../networks-and-tools/assets/metamask-setup.md) to see the new balance within the MetaMask extension. | |
| If you want to manage your local testnet tokens in MetaMask you will need to create a `t4` address. You can create a `t4` address using `lotus wallet new delegated`. Once you have a `t4` address you can [connect MetaMask to your local testnet](../../networks-and-tools/assets/metamask-setup.md) to see the new balance within the MetaMask extension. |
|
|
||
| * [Chain.love](https://lotus.filecoin.io/lotus/developers/chain-love/) - A hosted endpoint to Filecoin mainnet and testnet. Note: as of Q1 2023, Infura no longer supports Filecoin. | ||
| * The GLIF endpoint supports read-only calls and `MPoolPush()` for sending signed transactions to the network (which can be signed using the [Message signing tools](https://docs.filecoin.io/reference/general/overview/#message-signing-tools)). | ||
| * The GLIF endpoint supports read-only calls and `MPoolPush()` for sending signed transactions to the network (which can be signed using the [Message signing tools](./tools.md)). |
There was a problem hiding this comment.
The link text says “Message signing tools” but it points to reference/general/tools.md, which doesn’t have a clearly identifiable “message signing” section/anchor. Consider either updating the link text to match the destination (e.g., “Tools”) or adding a dedicated “Message signing” subsection in tools.md and linking to that anchor so readers can find the right info quickly.
Suggested change
| * The GLIF endpoint supports read-only calls and `MPoolPush()` for sending signed transactions to the network (which can be signed using the [Message signing tools](./tools.md)). | |
| * The GLIF endpoint supports read-only calls and `MPoolPush()` for sending signed transactions to the network (which can be signed using the [Tools](./tools.md)). |
Address review feedback by clarifying the Lassie install section, correcting the delegated wallet command, and making the GLIF signing reference match the linked docs. Made-with: Cursor
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs.filecoin.ioself-links to relative doc linksWELCOME.md,build/cookbook/README.md, andlegacy/smart-contracts/programmatic-storage/ccdb.mdsaturn.techlinks and fix malformed feedback links that were hitting docs pages directlyWhy
PR #53 is failing the
Check external linksworkflow ondocs/potential-candbecause this branch still contains many absolute production self-links and a few stale local paths. The production-site URLs 404 during PR CI because the branch content is not yet live ondocs.filecoin.io.Validation
npm run check-linksnpm run check:redirects