The documentation is currently hosted on http://wiki.tron.network
We encourage TRON community members to participate in the revision of our Wiki files regarding their content and format.
- Sign in to Github. Enter Wiki repository on TRON Protocol homepage and create a new fork.
- Clone the Wiki repository to your local repository.
- Submit your revised file to future branch in Wiki repository.
- Revise the existing files or create new files in the docs folder. Save images to the img folder in the docs folder.
- Submit your revised file to the future branch in Wiki repository.
Notes
-
Before getting down to revision, please first make sure you know how to configure Git and create repository. Mac users can download Git here.
-
Before getting down to revision, please also acquaint yourself with RST grammar and the document generator Sphinx.
-
Once you’ve completed your revision, please submit it to the future branch in Wiki repository.
-
Please make sure to revise the existing files or create new files in docs folder.
For user not knowing how to use Sphinx, we welcome you participate in the revision of file contents and be concerned about file layout or format. You needless spare your attention to other files in the Wiki folder besides RST files in the docs folder.
Regarding docs files, please note the following:
- Don’t delete or edit any file that’s not in RST format, e.g. conf.py, inde.html, Makefile etc.
- Changes in index.rst files will be directly reflected in file directory.
- Headings for RST files:
- ==== symbolizes H1, ---- symbolizes H2 and ~~~~ symbolizes H3.
- Changes to headings under ==== in the index.rst file will alter the general directory.
- Changes to headings under ---- and ~~~~ will alter the table of contents in individual RST files.
