docs: terminology, link, and markdown-lint cleanup across nav docs#624
Open
abn2357 wants to merge 8 commits into
Open
docs: terminology, link, and markdown-lint cleanup across nav docs#624abn2357 wants to merge 8 commits into
abn2357 wants to merge 8 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 developers.tron.network/reference links with local relative paths for interfaces that now have local pages. The parameter-ID mapping link in private_network.md is redirected to the java-tron ProposalType enum source, and the v4.4.0 JSON-RPC reference is pointed to the local json-rpc overview. Tutorial /docs/ links without a local counterpart are left unchanged.
Replace "dynamic parameter" and "dynamic network parameter" with "network parameter" across nav docs, smoothing wording where the literal replacement produced "network ... network" repetition.
De-indent top-level list items that were offset by 1-3 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.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 Remove DEX page from nav and fix multi-sig cross-reference #622, 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