Skip to content

Docs/review fixes - #25

Open
YukiXue1 wants to merge 11 commits into
TronLink:mainfrom
YukiXue1:docs/review-fixes
Open

YukiXue1 wants to merge 11 commits into
TronLink:mainfrom
YukiXue1:docs/review-fixes

Conversation

@YukiXue1

@YukiXue1 YukiXue1 commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

No description provided.

Tron and others added 11 commits May 29, 2026 11:33
Brings in AI-support docs overhaul, llms.txt bundles, reference pages,
schema-parity CI, and dapp window.tron migration from TronLink/docs main.
Apply the "safe to execute" subset of the developer-docs review, with
every code/external fact verified against the real TronLink repos and
npm registry (not the report's claims):

- P0-3: pin @bankofai/agent-wallet to exact 2.3.0 + GitHub 404 / npm pack
  audit note (npm latest 2.4.0 and the 404 confirmed).
- P1-1: mcp-tronlink-signer "which to use" 3-way table.
- P1-2: mcp-tronlink-signer inline schema mirror (field names from the
  published tool set; types deferred to list_tools).
- P1-4: tronlink-mcp-core scenario decision matrix vs mcp-server-tronlink.
- P1-6: mcp-server-tronlink wallet path A/B scenario decision table.
- P1-7: mcp-tronlink-signer relationship/version note (tronlink-signer
  0.1.4, co-released; verified on npm).
- P1-3 / P2-6 / Skill-P2-2: token-contract SSOT in reference/networks
  (addresses from tronlink-skills KNOWN_TOKENS; CLI/Skills reconciled).
  Corrected the report's wrong USDD address (it pointed at deprecated
  USDDOLD) to the current USDD TXDk8mbtRbXeYuMNS83CfKPaYYT8XWv9Hz.
- P2-1: mcp-server end-to-end agent dialogue example.
- P2-2: Flow Recipes "source file" column (mapping verified via source).
- P2-4: signer inline-changelog sync policy note.
- P2-7: ai-llms version-contract reference.
- Skill-P2-1/3/4: Skills troubleshooting section, TronGrid key 5-dim
  management, end-to-end dialogue examples.

Flow counts/rows left intact (both contested flows exist in code; the
count fix is a separate item). llms.txt / llms-full.* regenerated via
scripts/gen_llms_full.py.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The canonical docs repo TronLink/docs already exists (xueyuanying/docs is
just a fork), so only the in-doc URL needs fixing — no migration required.
Change the check-doc-schema-parity.yml link in mcp-server-tronlink.{en,zh}
from xueyuanying/docs to TronLink/docs; llms.txt / llms-full.* regenerated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The earlier review claim that chainTransferTrc20Flow / chainSwapV3Flow
don't exist is false — both are in src/flows/onchain.ts and registered.
The real issue was only the headline count: the page lists 24 flows
(Playwright 4 + on-chain 11 + multisig 6 + gasfree 3) which matches the
code registry (24 builtinFlows), but the heading/overview/mermaid/tree
said 32. Change those four "32"s to "24"; no flow rows removed, on-chain
stays 11. llms.txt / llms-full.* regenerated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The default MkDocs slugify strips CJK, so the ZH heading "### 错误码"
got an unstable numeric id and the 3 cross-doc SSOT links
(tronlink-mcp-core.md#错误码 from mcp-server / cli / signer) didn't
resolve. Make the heading bilingual ("错误码 (Error Codes)") so it
slugifies to the stable #error-codes (matching the EN side) and point
the ZH links there. Build-verified: those links now resolve, no new
broken anchors. llms.txt / llms-full.* regenerated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Internal developer-doc review report; should not live in the published
docs repo. (Re-applies the removal that an erroneous force-push reverted.)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The default MkDocs slugify strips CJK, so ZH headings got unstable
(or ugly, e.g. TronLink#6) ids and several in-page / cross-doc links didn't
resolve. Enable the attr_list extension and pin explicit English
anchor ids on 11 CJK headings (matching the EN-side slugs), then
repoint every link to them:

- mcp-tronlink-signer.zh: #errors, #environment-variables,
  #version-license, #inline-changelog
- mcp-server-tronlink.zh: #selected-tool-schemas-inline-mirror,
  #wallet-secret-storage
- tronlink-signer.zh: #broadcast-result
- tronlink-skills.zh: #skill-mcp-tool-map, #the-6-skills
- deeplink.zh: #result-code
- active-requests.zh: #get-tronlink-provider-via-tip-6963

Also fix same-class EN-side broken links surfaced by the build
(double-hyphen typos: #version--license, #skill--mcp-tool-map).

gen_llms_full.py now strips trailing ` { #id }` from headings so the
plain-text bundles don't leak attr_list syntax (narrow regex: id-only
blocks at end-of-line, leaves `Promise<{ ... }>` headings intact).
llms.txt / llms-full.* regenerated.

Build-verified: zero "no such anchor" warnings site-wide (was 4),
bundles carry no attr_list leakage.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- remove plugin-wallet-refactor-plan.md (internal planning doc)
- remove ai-readability-review.md (internal external review report)
- revert gh-pages.yml so only main triggers deploy (preview line for
  docs/review-fixes was for local dev only)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…tion)

The new troubleshooting table linked to #_1, a positional auto-anchor.
With the default slugify dropping CJK, #_1 resolves to the first
empty-slug heading (## 概述 / Overview) — not ## 配置说明. Give the
Configuration heading an explicit attr_list id and point the link at it
so it stays stable across heading edits. Matches the EN side, which
already uses a stable anchor.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…only)

The "Built-In Token Shortcuts" table documents the symbols tron_api.mjs
recognizes as aliases for contract addresses, but the SSOT-reconcile pass
added a USDD row the code does not recognize — then footnoted that it must
be passed by address anyway. That contradicts the table's purpose: an agent
scanning it would call symbol "USDD" and fail.

Make the table strictly equal the code whitelist (TRX/USDT/USDC/WTRX/BTT/
JST/SUN/WIN) and rewrite the note to point unlisted tokens (e.g. USDD) to
the networks SSOT for their address. USDD stays in the networks SSOT and
CLI reference tables (those are address catalogs, not symbol whitelists).
Regenerated llms-full bundles.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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.

1 participant