docs: terminology, link, and markdown-lint cleanup across nav docs#344
Open
abn2357 wants to merge 12 commits into
Open
docs: terminology, link, and markdown-lint cleanup across nav docs#344abn2357 wants to merge 12 commits into
abn2357 wants to merge 12 commits into
Conversation
Strip the leading '$ ' prompt from shell command examples across the docs so commands can be copied and run directly. Indentation, inline $VAR references, and line continuations are left untouched.
Replace Chinese terms 通证/代币 with lowercase token in documents referenced by the mkdocs.yml nav, applying CJK-Latin spacing. The dex and wallet-cli docs, although present in the nav, are excluded from this change.
Replace the Chinese term 见证人 and prose English witness with 超级代表 in documents referenced by the mkdocs.yml nav. Code identifiers, API paths, CLI flags, proto fields, error strings and the owner/witness/active permission names are left unchanged. The dex and wallet-cli docs, although present in the nav, are excluded from this change.
Replace developers.tron.network/reference links with local relative paths for interfaces that now have local pages. The proposal序号 mapping link in private_network.md is redirected to the java-tron ProposalType enum source instead. Tutorial /docs/ links without a local counterpart are left unchanged.
Replace the developers.tron.network JSON-RPC reference link with the local json-rpc overview page.
Replace 动态参数 and 动态网络参数 with 网络参数 across nav docs, and smooth wording where the literal replacement produced 网络...网络参数 repetition.
Replace the governance-proposal noun 提议 with 提案 across nav docs. The verb usage in demo.md (提议给 = "propose to") is left unchanged.
De-indent top-level list items that were offset by 1-2 spaces and normalize nested items to 4-space indentation. The repo ships no markdownlint or editorconfig config, so list indentation is dictated by the renderer: MkDocs Material uses python-markdown with the default tab_length=4, which requires 4-space nesting (markdownlint's CommonMark default of 2 does not apply here). Whitespace only; no content changes.
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
1 participant
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.
Summary
Documentation consistency pass across nav docs.
Terminology unification
Links
developers.tron.networkpages to local API docs; the parameter-ID mapping link is redirected to the java-tronProposalTypeenum source.Formatting / markdownlint
$shell prompts from command examples so they can be copied and run directlytab_length=4; repo ships no markdownlint config)ALLOW_TVM_TRANSFER_TRC10andShieldedTRC20Parametersleft untouched)All terminology/link/TRC edits are content-preserving except for the intended substitutions; all formatting edits are whitespace- or fence-tag-only.
Scope
Changes are limited to files referenced in
mkdocs.ymlnav. Two files are deliberately excluded:dex.md— being removed from the nav in Docs cleanup: DEX nav removal, resource intro, multi-sig cross-ref #343, so it is left untouched here.wallet-cli.md— its content is outdated and contains a number of errors; it will be removed and rewritten in a follow-up, so it is left untouched here.Test plan
dex.mdandwallet-cli.mduntouched; all edited files present inmkdocs.ymlnav