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](https://git.hush.is/hush/hush3) 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
@ -9,7 +11,13 @@ See the `script` directory for the `hush.go` script that generates the output an
1. Ensure that you have Go installed and a working and running `hushd` instance and that the `hush-cli` executable is within your path.
1. Edit the 4 fields in the `script\templates.html` file with the hushd version number you're generating Hush RPC calls for.
1. 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`.
1. Then you copy those generated files to the `/rpc` subdirectory of the `faq.hush.is` repo and send a PR there. Currently this repo is only used to store the `hush.go` binary and template HTML. Yes this is confusing, plz improve the situation if you can.
### 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](https://git.hush.is/hush/hush3).
1. If you have trouble merging because it's way too many files & have to use the git CLI, then follow instructions in [this Issue](https://git.hush.is/hush/faq.hush.is/issues/9).
