search

spesmilo / electrum-docs

Documentation for Electrum Bitcoin Wallet
https://docs.electrum.org/
MIT License
126 stars 146 forks source link

Add docs about Revealer plugin copied from revealer.cc #125

Open rocketeerbkw opened 3 years ago

rocketeerbkw commented 3 years ago

As mentioned in https://github.com/spesmilo/electrum/issues/7358 the website for the Revealer plugin has issues. This PR copies all the data and images from revealer.cc to the electrum docs. Some minor/major grammar changes have been made as well as some larger structure changes. References to Revealer the product have been removed.

rocketeerbkw commented 3 years ago

I have one bug that I can't figure out the issue/fix. On all pages except the plugins/index page, the links to the revealer pages work correct. But on the plugins/index page the link is missing the plugins subfolder. This causes 404 errors if you first click on Plugins and then you try to click on a Revealer page like How to Use.

Link in sidebar is correct on the home (and all other) page:

Fullscreen_6_23_21__10_59_PM

Link in sidebar (and in the toctree in the body) the link is missing plugins subfolder:

Fullscreen_6_23_21__11_00_PM
tiagotrs commented 3 years ago

Thank you for this!
For me your PR builds without the bug you mentioned - I can click in plugins and then in any sub page with no issues.

rocketeerbkw commented 3 years ago

I tried wiping my local setup and starting from scratch, still broken for me. Maybe I'm running the wrong build command sphinx-build -ab html . _build/html?

If you tested it and will sign off, then I guess that's good enough for me.