Skip to content

docs(protocol): consolidate guides and update README index #6870

Closed
Sunny6889 wants to merge 5 commits into
tronprotocol:release_v4.8.2from
Little-Peony:fix_readme
Closed

docs(protocol): consolidate guides and update README index #6870
Sunny6889 wants to merge 5 commits into
tronprotocol:release_v4.8.2from
Little-Peony:fix_readme

Conversation

@Sunny6889

Copy link
Copy Markdown
Contributor

What does this PR do?
Gather the project's scattered docs under docs/, give them consistent lower-case names, and surface them from a new README Documentation index.

Why are these changes required?

  • No entry point: several guides (protocol doc, metrics changelog, config reference) existed but were unlinked — readers had no path to them from the README.
  • Root/tree clutter: METRICS_CHANGELOG.md and the protobuf protocol doc sat outside docs/, mixed in with build files and proto sources.
  • Stale duplicates: two 2022-era protocol copies under protocol/src/main/protos/ had no indication they were outdated, risking readers trusting the wrong file.
  • SR key safety: the config guide didn't warn that a plaintext block-producing key can be leaked via file perms or committed to Git.

This PR has been tested by:

  • Manual Testing

Follow up

Extra details

@Sunny6889 Sunny6889 changed the title docs: consolidate guides under docs/ and add a README documentation index docs: consolidate guides and add a README documentation index Jul 13, 2026
@Sunny6889 Sunny6889 changed the title docs: consolidate guides and add a README documentation index docs(): consolidate guides and add a README documentation index Jul 13, 2026
@Sunny6889 Sunny6889 changed the title docs(): consolidate guides and add a README documentation index docs(metrics, protocol): consolidate guides and add a README documentation index Jul 13, 2026
@Sunny6889 Sunny6889 changed the title docs(metrics, protocol): consolidate guides and add a README documentation index docs(protocol): consolidate guides and update README documentation index Jul 13, 2026
@Sunny6889 Sunny6889 changed the title docs(protocol): consolidate guides and update README documentation index docs(protocol): consolidate guides and update README index Jul 13, 2026
@Sunny6889 Sunny6889 changed the title docs(protocol): consolidate guides and update README index docs(protocol): consolidate guides and update README index Jul 13, 2026
@Sunny6889 Sunny6889 closed this Jul 13, 2026
@Sunny6889
Sunny6889 deleted the fix_readme branch July 13, 2026 03:54
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