Skip to content

fix(misc): docs weekly audit 2026-08-10 - #3754

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/markdown-docs-audit-9707
Draft

fix(misc): docs weekly audit 2026-08-10#3754
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/markdown-docs-audit-9707

Conversation

@cursor

@cursor cursor Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Weekly Docs Audit - 2026-08-10

Automated audit of all Markdown files. Issues requiring human review are listed below.


Fixed Issues

Stale Version Claims Auto-Fixed (2)

File Line Old Version New Version Canonical Source
CONTRIBUTING.md 9 JDK | 21 JDK | 25 buildSrc/src/main/groovy/lineth.kotlin-common-minimal-conventions.gradle (JavaLanguageVersion.of(25)); also matches .github/actions/setup-java-and-gradle/action.yml default 25 and root AGENTS.md line 62 (JDK 25).
AGENTS.md 183 Solhint 6.2.1 Solhint 6.2.3 contracts/package.json ("solhint": "6.2.3").

Stale Cross-References Auto-Fixed (0)

None.


Remaining Issues (Requires Human Review)

[HIGH] Permission inconsistency: SDK npm scope contradicts published package names

  • Location A: ts-libs/sdk/AGENTS.md:69-70 - lists published packages as @lfdt-lineth/sdk-core and @lfdt-lineth/sdk-viem.
  • Location B: ts-libs/sdk/AGENTS.md:115 - "The @consensys npm scope must exist and the publishing account must have write access."
  • Source of truth: ts-libs/sdk/sdk-core/package.json, ts-libs/sdk/sdk-viem/package.json, and ts-libs/sdk/sdk-ethers/package.json all publish under the @lfdt-lineth scope.
  • Why ambiguous: The scope name is not a version claim or a cross-reference, so it does not fall under either auto-fixable category, but the @consensys prerequisite line is clearly inconsistent with the packages listed a few lines above and with the committed package.json names. Human should confirm whether the line should be rewritten to @lfdt-lineth (or removed) as part of the org rename.

[LOW] Stale cross-reference: broken anchor in docs/audits.md

  • Location: contracts/README.md:45 - links to ../docs/audits.md#linea-rollup-l2messageservice-and-tokenbridge-smart-contract-audits.
  • Problem: The target file exists but no heading in docs/audits.md produces that anchor. The closest current heading is ## Rollup, message service, and token bridge (anchor rollup-message-service-and-token-bridge).
  • Why ambiguous: Per audit rules, broken anchors are not auto-fixed even when the file resolves; a human should pick the correct heading (or add the historical anchor back) rather than have automation guess.

Audit Coverage

Checked 264 files (batched processing applied; > 200 files) across all 7 categories:

  • Terminology conflicts
  • Protocol contradictions
  • Lifecycle mismatches
  • Permission inconsistencies
  • Completion criteria inconsistencies
  • Enumerated value mismatches
  • Stale cross-references
Open in Web View Automation 

Co-authored-by: kyzooghost <kyzooghost@users.noreply.github.com>
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