fix: lychee root dir errors#6656
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Repository UI Review profile: CHILL Plan: Pro 📥 CommitsReviewing files that changed from the base of the PR and between a28f5c37d21374534b57b1011a9794315a3cbb07 and 69ced1c. 📒 Files selected for processing (16)
🚧 Files skipped from review as they are similar to previous changes (10)
WalkthroughUpdated lychee link-checker config and GitHub workflow, standardized internal docs links by removing Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
7694629 to
458c73e
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted filessee 8 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/users/filecoin_services.md`:
- Around line 7-11: The image tags use broken relative paths like
"../img/logo.png" which resolve incorrectly; update the src attributes in the
affected Markdown files (e.g., the <img src="../img/logo.png" ...>, <img
src="../img/chainsafe_logo.png" ...>, and <img src="../img/filecoin_logo.png"
...> entries) to use Docusaurus static asset absolute paths (e.g.,
"/img/logo.png", "/img/chainsafe_logo.png", "/img/filecoin_logo.png") or correct
relative locations pointing to the static folder; apply the same fix to the
other files mentioned (users/introduction.md and users/funding.md) so all image
references load from the docs/static/img asset directory.
In `@docs/README.md`:
- Around line 59-61: Update the CLI Docs script reference in README.md: replace
the incorrect path "./docs/users/reference/generate_cli_md.sh" with the correct
path "./docs/docs/users/reference/generate_cli_md.sh" so the link points to the
actual script location referenced in the diff under the "#### CLI Docs" section.
ℹ️ Review info
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.config/lychee.tomldocs/README.mddocs/docs/developers/guides/trace_call_guide.mddocs/docs/developers/introduction.mddocs/docs/users/filecoin_services.mddocs/docs/users/funding.mddocs/docs/users/introduction.md
✅ Files skipped from review due to trivial changes (1)
- docs/docs/developers/introduction.md
a28f5c3 to
69ced1c
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/docs/users/reference/env_variables.md (1)
37-38: Optional wording polish: replace “Whether or not” with “Whether”These descriptions can be shortened for consistency and readability without changing meaning.
Also applies to: 47-47, 53-53, 55-55, 57-57
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/users/reference/env_variables.md` around lines 37 - 38, Update the descriptions that use "Whether or not" to the shorter "Whether" for consistency and readability: change the descriptions for the environment variables `FOREST_F3_SIDECAR_FFI_ENABLED` and `FOREST_F3_CONSENSUS_ENABLED` to start with "Whether" instead of "Whether or not", and apply the same replacement to the other similar entries mentioned (the entries at the other referenced lines) so all matching env var descriptions use "Whether" consistently..github/workflows/link-check.yml (1)
39-39: Optional cleanup:./AGENTS.mdis redundant with./*.md.Line 39 already includes root Markdown files via
./*.md, so the explicit./AGENTS.mdcan be dropped unless you want extra explicitness.Diff
- args: --user-agent "curl/8.5.0" --no-progress --config ./.config/lychee.toml './*.md' './AGENTS.md' + args: --user-agent "curl/8.5.0" --no-progress --config ./.config/lychee.toml './*.md'🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/link-check.yml at line 39, Remove the redundant './AGENTS.md' entry from the link-check args since './*.md' already matches root Markdown files; edit the args line that currently contains --config ./.config/lychee.toml './*.md' './AGENTS.md' and drop the './AGENTS.md' token so only './*.md' remains, preserving the rest of the flags (e.g., --user-agent and --no-progress) unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/users/reference/env_variables.md`:
- Line 23: Update the docs table entry for FOREST_RPC_MAX_CONNECTIONS to reflect
that 0 is valid by changing the constraint text from "positive integer" to
"non-negative integer" (or "integer >= 0") in
docs/docs/users/reference/env_variables.md; leave src/rpc/mod.rs unchanged since
the code intentionally accepts 0 and requires no validation changes.
---
Nitpick comments:
In @.github/workflows/link-check.yml:
- Line 39: Remove the redundant './AGENTS.md' entry from the link-check args
since './*.md' already matches root Markdown files; edit the args line that
currently contains --config ./.config/lychee.toml './*.md' './AGENTS.md' and
drop the './AGENTS.md' token so only './*.md' remains, preserving the rest of
the flags (e.g., --user-agent and --no-progress) unchanged.
In `@docs/docs/users/reference/env_variables.md`:
- Around line 37-38: Update the descriptions that use "Whether or not" to the
shorter "Whether" for consistency and readability: change the descriptions for
the environment variables `FOREST_F3_SIDECAR_FFI_ENABLED` and
`FOREST_F3_CONSENSUS_ENABLED` to start with "Whether" instead of "Whether or
not", and apply the same replacement to the other similar entries mentioned (the
entries at the other referenced lines) so all matching env var descriptions use
"Whether" consistently.
ℹ️ Review info
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 354aab9 and a28f5c37d21374534b57b1011a9794315a3cbb07.
📒 Files selected for processing (16)
.config/lychee.toml.github/workflows/link-check.ymldocs/docs/developers/guides/rpc_stateful_tests.mddocs/docs/users/filecoin_services.mddocs/docs/users/getting_started/syncing.mddocs/docs/users/guides/advanced/backups.mddocs/docs/users/guides/advanced/generating_snapshots.mddocs/docs/users/guides/exporting_wallet_to_metamask.mddocs/docs/users/guides/methods_filtering.mddocs/docs/users/introduction.mddocs/docs/users/knowledge_base/docker_tips.mddocs/docs/users/reference/env_variables.mddocs/docs/users/reference/json-rpc/methods.mdxdocs/docs/users/reference/json-rpc/overview.mddocs/docs/users/reference/json-rpc/schema.mdxdocs/docusaurus.config.js
✅ Files skipped from review due to trivial changes (2)
- docs/docs/users/reference/json-rpc/methods.mdx
- docs/docs/users/reference/json-rpc/overview.md
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/docs/users/filecoin_services.md
- docs/docs/users/introduction.md
Summary of changes
Changes introduced in this pull request:
-let docusaurus deal with link checks
Reference issue to close (if applicable)
Closes
Other information and links
Change checklist
Outside contributions
Summary by CodeRabbit