docs: add Agent-friendly entry index and source-derived API specs#627
Merged
Conversation
- Add docs/llms.txt as an AI entry index linking the API references and node operation pages (served at /llms.txt). - Declare documentation-en as the authoritative source on the home page, with documentation-zh as the translation that follows it. - Add a warning in the SR setup section to chmod 600 the config, never commit a config file with a real private key, and prefer keystore.
abn2357
changed the title
abn2357
force-pushed
the
add_agent_friendly_doc
branch
2 times, most recently
from
33a18b8 to
047f62e
Compare
abn2357
force-pushed
the
add_agent_friendly_doc
branch
from
047f62e to
19cb333
Compare
kuny0707
approved these changes
Jun 30, 2026
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
4 participants
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
docs/llms.txtas an Agent entry index linking the API references and node-operation pages (served at/llms.txt).docs/api/openapi.yaml), OpenRPC (docs/api/openrpc.json), and per-endpoint HTTP / JSON-RPC spec files underdocs/api/specs/.Spec generation
The specs are produced with a base + per-endpoint overlay workflow: each HTTP path and JSON-RPC method is derived from a source-extracted base and refined by an endpoint-specific overlay, replacing the earlier monolithic generation approach. This yields more accurate per-interface fragments, which bundle into the top-level
openapi.yaml/openrpc.json. The local generation assets (java-tron source dump, overlays, scripts) are kept out of the repo via.gitignore.Spec quality assurance
The regenerated definitions go through a fine-grained, layered audit and cross-validation across multiple large language models — covering error response modeling, JSON content typing, integer formats, nested object schemas, and JSON-RPC result shapes — for higher-quality SDK generation.
Unrelated fixes bundled in
The following two items are not part of the Agent-friendly docs theme. They address two optimization items surfaced by the routine AI audit report and are included here for convenience:
documentation-enas the authoritative source on the home page, withdocumentation-zhas the translation that follows it.chmod 600the config, never commit a config file with a real private key, and prefer keystore.Test plan
mkdocs buildsucceeds with the new pages andmkdocs.ymlnav entry./llms.txtresolves and its links point to valid pages.