Skip to content

docs: weekly audit 2026-05-18#3134

Merged
kyzooghost merged 1 commit into
mainfrom
cursor/docs-internal-consistency-0823
May 18, 2026
Merged

docs: weekly audit 2026-05-18#3134
kyzooghost merged 1 commit into
mainfrom
cursor/docs-internal-consistency-0823

Conversation

@cursor
Copy link
Copy Markdown
Contributor

@cursor cursor Bot commented May 18, 2026

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)

File Line Old Version New Version Canonical Source
AGENTS.md 181 Prettier 3.7.4 Prettier 3.8.1 pnpm-workspace.yaml catalog (prettier: 3.8.1)
AGENTS.md 182 ESLint 9.39.2 ESLint 9.39.4 pnpm-workspace.yaml catalog (eslint: 9.39.4) and overrides
AGENTS.md 183 Solhint 6.0.3 Solhint 6.2.1 contracts/package.json ("solhint": "6.2.1")
AGENTS.md 226 Jest 29.7.0 Jest 30.3.0 pnpm-workspace.yaml catalog (jest: 30.3.0)
ts-libs/sdk/AGENTS.md 35 ethers 6.13.7 ethers 6.16.0 pnpm-workspace.yaml catalog (ethers: 6.16.0) consumed via ts-libs/sdk/sdk-ethers/package.json ("ethers": "catalog:")
ts-libs/sdk/AGENTS.md 49 Jest 29.7.0 Jest 30.3.0 pnpm-workspace.yaml catalog (jest: 30.3.0)
postman/AGENTS.md 107 Jest 29.7.0 Jest 30.3.0 pnpm-workspace.yaml catalog (jest: 30.3.0)

Stale Cross-References Auto-Fixed (2)

File Line Old Path New Path
linea-besu/plugins/linea-sequencer/README.md 5 ../../LICENSE-APACHE ../../../LICENSE-APACHE
linea-besu/plugins/linea-sequencer/README.md 5 ../../LICENSE-MIT ../../../LICENSE-MIT

The README sits at linea-besu/plugins/linea-sequencer/, so the existing ../../ resolved to linea-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 repo

  • Location: AGENTS.md:366 — table row `corset` | Compiler | Rust 2021 (1.70.0+), Cargo | Constraint system compiler (cdylib + CLI)
  • Location: AGENTS.md:374 — repository map `corset/ Rust constraint compiler`
  • Location: docs/tech/components/corset.md — entire file describes a missing directory
  • Location: docs/tech/components/README.md:20 — table row [Corset](./corset.md) | Rust | `corset/` | …
  • Location: docs/tech/README.md:47 — repository map `└── corset/ # Constraint compiler`
  • Location: docs/features/README.md:28 — table row Corset | Rust | `corset/` | CLI + shared library
  • Location: docs/features/tracer.md:21 — table row Corset | `corset/` | Rust-based trace expander (prover-side)
  • Location: docs/features/prover.md:18 — table row Corset | `corset/` | Rust trace expander (compiled into prover binary)
  • Problem: No corset/ directory exists at the repo root. The constraint compiler appears to live in the external github.com/Consensys/go-corset repository (referenced from prover/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

  • Location A: docs/tech/components/corset.md:74 — "Rust 1.70.0+"
  • Location B: AGENTS.md:366 — "Rust 2021 (1.70.0+), Cargo"
  • Why ambiguous: No 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 the corset/ documentation cleanup above is decided.

[HIGH] Lifecycle mismatch: tracer setup procedure documented two different ways

  • Location A: tracer/SETUP.md:16 — "Install Go-Corset" via go install github.com/consensys/go-corset/cmd/go-corset@latest; 5-step setup (Java, Go, Go-Corset, pre-commit, tests). Debug example uses go-corset check --report <…> tracer/linea-constraints/zkevm_osaka.bin.
  • Location B: tracer/docs/get-started.md:22 — "Install Corset" via cargo install --git ssh://git@github.com/Consensys/corset --locked --force; 6-step setup (Java, Go, Rust, Corset, constraints submodule, pre-commit). Debug example uses corset check -T <…> linea-constraints/zkevm.bin.
  • Why ambiguous: The two documents prescribe materially different setup paths (Go binary vs Rust+Cargo build, different toolchains, different submodule initialization, different debug binary names). The canonical procedure must be confirmed by the tracer team before consolidating; auto-merging would silently drop or invent install commands. (Carried over.)

[HIGH] Lifecycle/duplication mismatch: tracer plugin docs duplicated and drifting

  • Location A: tracer/PLUGINS.md
  • Location B: tracer/docs/plugins.md
  • Why ambiguous: Both files cover the continuous tracing plugin and have diverged. Picking the canonical file (and what to delete or redirect) is a content/ownership decision, not a mechanical fix. (Carried over.)

[MEDIUM] Enumerated value mismatch: besu-plugins acceptance-tests Solidity version

  • Location: linea-besu/plugins/AGENTS.md:59 — "Use Web3j contract wrappers generated from Solidity 0.8.19"
  • Counter-evidence: linea-besu/plugins/linea-sequencer/acceptance-tests/src/test/solidity/*.sol use pragma solidity >=0.7.0 <0.9.0; and pragma solidity ^0.8.0;. linea-besu/plugins/linea-sequencer/acceptance-tests/build.gradle does not pin a solcVersion for the web3jSolidity plugin.
  • Why ambiguous: No source/configuration file in the repo establishes "0.8.19" as the canonical compile version for these test contracts. Replacing with a different number (e.g. 0.8.33 from contracts/) would be inventing a value rather than reflecting a pinned configuration. (Carried over.)

[LOW] Stale cross-reference: prose paths inside lido-governance-monitor docs use package-relative paths in backticks

  • Location: operations/native-yield-operations/lido-governance-monitor/docs/architecture.md:289 — refers to `src/prompts/risk-assessment-system.md`
  • Location: operations/native-yield-operations/lido-governance-monitor/docs/evals.md:71 — same
  • Problem: The file exists at operations/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:

  • Terminology conflicts
  • Protocol contradictions
  • Lifecycle mismatches
  • Permission inconsistencies
  • Completion criteria inconsistencies
  • Enumerated value mismatches
  • Stale cross-references

Note: corpus exceeds the 200-file batching threshold; processed in batches with a running cross-reference index.

Open in Web View Automation 

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, and ts-libs/sdk/AGENTS.md to 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.md relative 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.

@github-actions
Copy link
Copy Markdown
Contributor

tx-exclusion-api Changelog Preview (informational)

[Unreleased] diff (commits touching tx-exclusion-api/** since latest releases/tx-exclusion-api/v* tag)

[unreleased]

Generated by git-cliff-action using cliff.toml. This comment is informational and does not gate the PR.

@github-actions
Copy link
Copy Markdown
Contributor

prover Changelog Preview (informational)

[Unreleased] diff (commits touching prover/** since latest releases/prover/v* tag)

[unreleased]

🐛 Bug Fixes

Generated by git-cliff-action using cliff.toml. This comment is informational and does not gate the PR.

@github-actions
Copy link
Copy Markdown
Contributor

postman Changelog Preview (informational)

[Unreleased] diff (commits touching postman/** since latest releases/postman/v* tag)

[unreleased]

Generated by git-cliff-action using cliff.toml. This comment is informational and does not gate the PR.

@github-actions
Copy link
Copy Markdown
Contributor

linea-besu Changelog Preview (informational)

[Unreleased] diff (commits touching linea-besu/** since latest releases/linea-besu/v* tag)

[unreleased]

Generated by git-cliff-action using cliff.toml. This comment is informational and does not gate the PR.

@github-actions
Copy link
Copy Markdown
Contributor

coordinator Changelog Preview (informational)

[Unreleased] diff (commits touching coordinator/** since latest releases/coordinator/v* tag)

[unreleased]

Generated by git-cliff-action using cliff.toml. This comment is informational and does not gate the PR.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.23%. Comparing base (ae7e989) to head (df9c68e).

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           
Flag Coverage Δ *Carryforward flag
hardhat 96.17% <ø> (ø) Carriedforward from ae7e989
kotlin 55.84% <ø> (ø) Carriedforward from ae7e989
lido-governance-monitor 97.61% <ø> (ø) Carriedforward from ae7e989
linea-native-libs 90.69% <ø> (ø) Carriedforward from ae7e989
linea-shared-utils 96.18% <ø> (ø) Carriedforward from ae7e989
native-yield-automation-service 97.68% <ø> (ø) Carriedforward from ae7e989
postman 99.92% <ø> (ø) Carriedforward from ae7e989
sdk-core 98.09% <ø> (ø)
sdk-ethers 89.83% <ø> (ø)
sdk-viem 99.45% <ø> (ø)
tracer 88.55% <ø> (ø) Carriedforward from ae7e989

*This pull request uses carry forward flags. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kyzooghost kyzooghost marked this pull request as ready for review May 18, 2026 08:04
@kyzooghost kyzooghost merged commit 8656507 into main May 18, 2026
29 checks passed
@kyzooghost kyzooghost deleted the cursor/docs-internal-consistency-0823 branch May 18, 2026 08:04
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.

4 participants