docs: weekly audit 2026-05-18#3134
Merged
Merged
Conversation
Contributor
tx-exclusion-api Changelog Preview (informational)[Unreleased] diff (commits touching
|
Contributor
prover Changelog Preview (informational)[Unreleased] diff (commits touching
|
Contributor
postman Changelog Preview (informational)[Unreleased] diff (commits touching
|
Contributor
linea-besu Changelog Preview (informational)[Unreleased] diff (commits touching
|
Contributor
coordinator Changelog Preview (informational)[Unreleased] diff (commits touching
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3134 +/- ##
=========================================
Coverage 77.23% 77.23%
Complexity 7005 7005
=========================================
Files 1118 1118
Lines 44394 44394
Branches 5343 5343
=========================================
Hits 34286 34286
Misses 8749 8749
Partials 1359 1359
*This pull request uses carry forward flags. Click here to find out more. 🚀 New features to boost your workflow:
|
alainncls
approved these changes
May 18, 2026
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.
Weekly Docs Audit — 2026-05-18
Automated audit of all Markdown files. Issues requiring human review are listed below.
Fixed Issues
Stale Version Claims Auto-Fixed (7)
AGENTS.mdPrettier 3.7.4Prettier 3.8.1pnpm-workspace.yamlcatalog (prettier: 3.8.1)AGENTS.mdESLint 9.39.2ESLint 9.39.4pnpm-workspace.yamlcatalog (eslint: 9.39.4) and overridesAGENTS.mdSolhint 6.0.3Solhint 6.2.1contracts/package.json("solhint": "6.2.1")AGENTS.mdJest 29.7.0Jest 30.3.0pnpm-workspace.yamlcatalog (jest: 30.3.0)ts-libs/sdk/AGENTS.mdethers 6.13.7ethers 6.16.0pnpm-workspace.yamlcatalog (ethers: 6.16.0) consumed viats-libs/sdk/sdk-ethers/package.json("ethers": "catalog:")ts-libs/sdk/AGENTS.mdJest 29.7.0Jest 30.3.0pnpm-workspace.yamlcatalog (jest: 30.3.0)postman/AGENTS.mdJest 29.7.0Jest 30.3.0pnpm-workspace.yamlcatalog (jest: 30.3.0)Stale Cross-References Auto-Fixed (2)
linea-besu/plugins/linea-sequencer/README.md../../LICENSE-APACHE../../../LICENSE-APACHElinea-besu/plugins/linea-sequencer/README.md../../LICENSE-MIT../../../LICENSE-MITThe README sits at
linea-besu/plugins/linea-sequencer/, so the existing../../resolved tolinea-besu/LICENSE-APACHE/linea-besu/LICENSE-MIT(neither file exists). Glob finds the canonical repo-root licenses; using../../../resolves them correctly (verified by following the relative path from the file's directory).Remaining Issues (Requires Human Review)
[HIGH] Stale cross-reference:
corset/package directory referenced in many docs but does not exist in this repoAGENTS.md:366— table row`corset` | Compiler | Rust 2021 (1.70.0+), Cargo | Constraint system compiler (cdylib + CLI)AGENTS.md:374— repository map`corset/ Rust constraint compiler`docs/tech/components/corset.md— entire file describes a missing directorydocs/tech/components/README.md:20— table row[Corset](./corset.md) | Rust | `corset/` | …docs/tech/README.md:47— repository map`└── corset/ # Constraint compiler`docs/features/README.md:28— table rowCorset | Rust | `corset/` | CLI + shared librarydocs/features/tracer.md:21— table rowCorset | `corset/` | Rust-based trace expander (prover-side)docs/features/prover.md:18— table rowCorset | `corset/` | Rust trace expander (compiled into prover binary)corset/directory exists at the repo root. The constraint compiler appears to live in the externalgithub.com/Consensys/go-corsetrepository (referenced fromprover/AGENTS.md,tracer/SETUP.md,docs/tech/architecture/EXTERNAL-DEPENDENCIES.md). Removing or relocating these references is a structural documentation rewrite, not an auto-fixable path swap. (Carried over from prior audits.)[HIGH] Version requirement mismatch: corset.md prescribes Rust 1.70.0+ for a package not present in the repo
docs/tech/components/corset.md:74— "Rust 1.70.0+"AGENTS.md:366— "Rust 2021 (1.70.0+), Cargo"Cargo.toml,rust-toolchain*, or other authoritative source/configuration file in this repo establishes a Rust toolchain version. Both references describe an external project. Cannot be resolved until thecorset/documentation cleanup above is decided.[HIGH] Lifecycle mismatch: tracer setup procedure documented two different ways
tracer/SETUP.md:16— "Install Go-Corset" viago install github.com/consensys/go-corset/cmd/go-corset@latest; 5-step setup (Java, Go, Go-Corset, pre-commit, tests). Debug example usesgo-corset check --report <…> tracer/linea-constraints/zkevm_osaka.bin.tracer/docs/get-started.md:22— "Install Corset" viacargo install --git ssh://git@github.com/Consensys/corset --locked --force; 6-step setup (Java, Go, Rust, Corset, constraints submodule, pre-commit). Debug example usescorset check -T <…> linea-constraints/zkevm.bin.[HIGH] Lifecycle/duplication mismatch: tracer plugin docs duplicated and drifting
tracer/PLUGINS.mdtracer/docs/plugins.md[MEDIUM] Enumerated value mismatch: besu-plugins acceptance-tests Solidity version
linea-besu/plugins/AGENTS.md:59— "Use Web3j contract wrappers generated from Solidity 0.8.19"linea-besu/plugins/linea-sequencer/acceptance-tests/src/test/solidity/*.solusepragma solidity >=0.7.0 <0.9.0;andpragma solidity ^0.8.0;.linea-besu/plugins/linea-sequencer/acceptance-tests/build.gradledoes not pin asolcVersionfor theweb3jSolidityplugin.0.8.33fromcontracts/) would be inventing a value rather than reflecting a pinned configuration. (Carried over.)[LOW] Stale cross-reference: prose paths inside
lido-governance-monitordocs use package-relative paths in backticksoperations/native-yield-operations/lido-governance-monitor/docs/architecture.md:289— refers to`src/prompts/risk-assessment-system.md`operations/native-yield-operations/lido-governance-monitor/docs/evals.md:71— sameoperations/native-yield-operations/lido-governance-monitor/src/prompts/risk-assessment-system.md. The convention treats the path as package-relative (unambiguous in context) but is not resolvable as-written from the docs directory. Left for human review because rewriting prose paths into doc-relative../src/prompts/…paths is a stylistic decision, not a strictly broken link.Audit Coverage
Checked 236 files across all 7 categories:
Note
Low Risk
Low risk: documentation-only updates that align stated tool versions and fix broken relative license links, with no runtime or build logic changes.
Overview
Documentation audit fixes only. Updates version strings in
AGENTS.md,postman/AGENTS.md, andts-libs/sdk/AGENTS.mdto match current dependencies (Prettier 3.8.1, ESLint 9.39.4, Solhint 6.2.1, Jest 30.3.0, ethers 6.16.0).Fixes
linea-besu/plugins/linea-sequencer/README.mdrelative paths so the Apache/MIT license links resolve to the repo root.Reviewed by Cursor Bugbot for commit df9c68e. Bugbot is set up for automated code reviews on this repo. Configure here.