Hush RPC Documentation Generator

This tool extracts and formats the help text for each of the Hush RPC calls.

Note: If you want to actually edit any of this RPC info, then change the hushd code directly. This tool only take what the code (not in this repository) gives us and produces HTML output from it.

See the script directory for the hush.go script that generates the output and template.

How to use

1. Ensure that you have Go installed and a working and running hushd instance and that the hush-cli executable is within your path.
2. Edit the 4 fields in the script\templates.html file with the hushd version number you're generating Hush RPC calls for.
3. From the script directory simply run go run hush.go and the documentation will be produced for all Hush RPC calls and styled according to the template in template.html.

How to update faq.hush.is

After generating new RPC HTML files, follow below to update faq.hush.is's RPC info

1. Copy the generated files from this repo to the /rpc subdirectory of the faq.hush.is repo and make a PR there.
2. If you have trouble merging because it's way too many files & have to use the git CLI, then follow instructions in this Issue.

License

Released under the GPLv3 or later.

Copyright

The Hush Developers, 2021-2024
Karel Bilek, 2018 (MIT)