Unify heading anchor format and cross-file link style#597
Open
abn2357 wants to merge 4 commits into
Open
Conversation
Convert <a id="x"></a> tags and {: #x } syntax to inline { #id }
attributes on the target heading. Rename #primary/backup_upgrade and
#standard_process to kebab-case slugs and update their refs.
Replace vague or partial IDs (#step1, #other, #get-energy, #defi, etc.) with kebab-case slugs derived from the full heading, and update all in-file link references.
Replace https://tronprotocol.github.io/documentation-en/... links with repo-relative file.md (or file.md#anchor) references so cross-file navigation works locally and survives site moves. Retarget the stale architecture/plugin link to architecture/event.md and the moved developers/litefullnode link to using_javatron/litefullnode.md.
The previous absolute URL auto-linked in the renderer; the relative path replacement did not, leaving the reference as plain text. Wrap it in Markdown link syntax and correct the anchor to match the heading (#leveldb-startup-optimization-tool).
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
<a id=\"x\"></a>tags and{: #x }syntax to inline{ #id }attr_list attributes on the target heading across all docs with anchors.#step1,#defi,#gasfree,#rndstep1,#other,#get-energy) to kebab-case slugs that fully reflect the heading text, and update all in-file link references.https://tronprotocol.github.io/documentation-en/...cross-file links with repo-relativefile.md#anchorpaths so navigation works locally and survives site moves; retarget the stalearchitecture/plugin/#tron-event-subscriptionlink toarchitecture/event.mdand the moveddevelopers/litefullnodelink tousing_javatron/litefullnode.md.Test plan
<a id=\"...\"></a>,{: #...}, orhttps://tronprotocol.github.io/documentation-en/...patterns remain (grep).