docs: add AGENTS.md and improve documentation discoverability#6865
Closed
Sunny6889 wants to merge 5 commits into
Closed
docs: add AGENTS.md and improve documentation discoverability#6865Sunny6889 wants to merge 5 commits into
Sunny6889 wants to merge 5 commits into
Conversation
e1470e0 to
3c55d86
Compare
3c55d86 to
f339051
Compare
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
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.
What does this PR do?
Documentation-only change (no code or build changes) that makes the project easier to navigate for new contributors and AI coding assistants:
AGENTS.mdat the repository root — a concise contributor/AI guide covering build & test commands, the module layout and one-way dependency direction, the hard constraints (cross-JVM determinism, DBSessionusage, actuator / protobuf / API / thread rules), coding & security rules, and the commit convention.README.mdlinking the guides underdocs/(configuration, modular architecture & deployment, implementing a customized actuator) and the authoritative Protobuf protocol document.Tron protobuf protocol document.md→docs/protobuf-protocol-document.md(pure rename, no content change): removes the spaces from the filename and consolidates it with the other guides underdocs/.protocol/src/main/protos/(English / Chinese, last updated 2022) as superseded, pointing readers to the maintained document.docs/configuration.mdon protecting a Super Representative's block-producing key (prefer the encrypted keystore, restrict file permissions, never commit a real key).Why are these changes required?
docs/guides were not linked from the README — hard for contributors and AI assistants to discover.protocol/src/main/protos/did not point to the maintained version.This PR has been tested by:
tronprotocol/documentation-en(the old filename in any form, java-tronblob/tree/rawlinks, and.mdlinks) — the file is not referenced there, so no links break.Follow up
AGENTS.mdfrom the developer documentation site.Extra details
Tron protobuf protocol document.md(repo root) →docs/protobuf-protocol-document.md. Rename only; content unchanged.