Skip to content

fix: lychee root dir errors#6656

Merged
LesnyRumcajs merged 1 commit intomainfrom
fix-lychee-errors
Feb 26, 2026
Merged

fix: lychee root dir errors#6656
LesnyRumcajs merged 1 commit intomainfrom
fix-lychee-errors

Conversation

@LesnyRumcajs
Copy link
Copy Markdown
Member

@LesnyRumcajs LesnyRumcajs commented Feb 26, 2026

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

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Outside contributions

  • I have read and agree to the CONTRIBUTING document.
  • I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

  • Documentation
    • Standardized internal doc links (removed redundant extensions), updated anchors, and improved table formatting across guides and references for clearer navigation and readability.
  • Chores
    • Tweaked documentation validation and site config to improve link checking behavior and reporting.

@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner February 26, 2026 12:02
@LesnyRumcajs LesnyRumcajs requested review from akaladarshi and hanabi1224 and removed request for a team February 26, 2026 12:02
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a28f5c37d21374534b57b1011a9794315a3cbb07 and 69ced1c.

📒 Files selected for processing (16)
  • .config/lychee.toml
  • .github/workflows/link-check.yml
  • docs/docs/developers/guides/rpc_stateful_tests.md
  • docs/docs/users/filecoin_services.md
  • docs/docs/users/getting_started/syncing.md
  • docs/docs/users/guides/advanced/backups.md
  • docs/docs/users/guides/advanced/generating_snapshots.md
  • docs/docs/users/guides/exporting_wallet_to_metamask.md
  • docs/docs/users/guides/methods_filtering.md
  • docs/docs/users/introduction.md
  • docs/docs/users/knowledge_base/docker_tips.md
  • docs/docs/users/reference/env_variables.md
  • docs/docs/users/reference/json-rpc/methods.mdx
  • docs/docs/users/reference/json-rpc/overview.md
  • docs/docs/users/reference/json-rpc/schema.mdx
  • docs/docusaurus.config.js
🚧 Files skipped from review as they are similar to previous changes (10)
  • docs/docs/users/getting_started/syncing.md
  • docs/docs/developers/guides/rpc_stateful_tests.md
  • docs/docs/users/filecoin_services.md
  • docs/docs/users/guides/advanced/backups.md
  • docs/docs/users/reference/json-rpc/overview.md
  • docs/docs/users/reference/json-rpc/schema.mdx
  • .github/workflows/link-check.yml
  • docs/docs/users/guides/advanced/generating_snapshots.md
  • docs/docs/users/knowledge_base/docker_tips.md
  • docs/docs/users/guides/methods_filtering.md

Walkthrough

Updated lychee link-checker config and GitHub workflow, standardized internal docs links by removing .md/.mdx extensions across many docs, adjusted env var reference formatting, and switched Docusaurus broken-link config from onBrokenMarkdownLinks to onBrokenAnchors with markdown hook.

Changes

Cohort / File(s) Summary
Link Checker Configuration
.config/lychee.toml, .github/workflows/link-check.yml
Updated lychee excludes to explicit docs/ and build/, removed several host entries from the exclude list, added retry_wait_time = 10 and output = "lychee-report.md". Limited link-check workflow globs to top-level ./*.md and ./AGENTS.md.
Documentation Link Standardization
docs/docs/users/..., docs/docs/developers/guides/rpc_stateful_tests.md, docs/docs/users/reference/json-rpc/...
Removed .md/.mdx extensions from many internal links (CLI, JWT, snapshot, schema, methods, etc.) and a small inline formatting tweak in RPC stateful tests.
Docusaurus Configuration
docs/docusaurus.config.js
Replaced root onBrokenMarkdownLinks with onBrokenAnchors and added markdown.hooks.onBrokenMarkdownLinks: "throw".
Reference Documentation Table
docs/docs/users/reference/env_variables.md
Reformatted the environment variables table (header/separators) and added explanatory sections for some env vars; core entries unchanged.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • akaladarshi
  • hanabi1224
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: lychee root dir errors' directly addresses the main objective of fixing lychee link-checking behavior in the root directory and delegating docs validation to Docusaurus.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-lychee-errors

Comment @coderabbitai help to get the list of available commands and usage tips.

hanabi1224
hanabi1224 previously approved these changes Feb 26, 2026
@LesnyRumcajs LesnyRumcajs changed the title fix: lychee root errors fix: lychee root dir errors Feb 26, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.50%. Comparing base (4e638cd) to head (69ced1c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

see 8 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4e638cd...69ced1c. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Feb 26, 2026
github-merge-queue Bot pushed a commit that referenced this pull request Feb 26, 2026
@LesnyRumcajs LesnyRumcajs removed this pull request from the merge queue due to a manual request Feb 26, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 458c73e and 354aab9.

📒 Files selected for processing (7)
  • .config/lychee.toml
  • docs/README.md
  • docs/docs/developers/guides/trace_call_guide.md
  • docs/docs/developers/introduction.md
  • docs/docs/users/filecoin_services.md
  • docs/docs/users/funding.md
  • docs/docs/users/introduction.md
✅ Files skipped from review due to trivial changes (1)
  • docs/docs/developers/introduction.md

Comment thread docs/docs/users/filecoin_services.md
Comment thread docs/README.md Outdated
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md is redundant with ./*.md.

Line 39 already includes root Markdown files via ./*.md, so the explicit ./AGENTS.md can 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.yml
  • docs/docs/developers/guides/rpc_stateful_tests.md
  • docs/docs/users/filecoin_services.md
  • docs/docs/users/getting_started/syncing.md
  • docs/docs/users/guides/advanced/backups.md
  • docs/docs/users/guides/advanced/generating_snapshots.md
  • docs/docs/users/guides/exporting_wallet_to_metamask.md
  • docs/docs/users/guides/methods_filtering.md
  • docs/docs/users/introduction.md
  • docs/docs/users/knowledge_base/docker_tips.md
  • docs/docs/users/reference/env_variables.md
  • docs/docs/users/reference/json-rpc/methods.mdx
  • docs/docs/users/reference/json-rpc/overview.md
  • docs/docs/users/reference/json-rpc/schema.mdx
  • docs/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

Comment thread docs/docs/users/reference/env_variables.md Outdated
@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Feb 26, 2026
Merged via the queue into main with commit 4f8f41a Feb 26, 2026
45 checks passed
@LesnyRumcajs LesnyRumcajs deleted the fix-lychee-errors branch February 26, 2026 17:14
@coderabbitai coderabbitai Bot mentioned this pull request Apr 1, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants