New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restore documentation that had been moved to zcash.readthedocs.io #5953
Conversation
I'm not quite sure I understand this PR. Are we now going to support 2 sets of user style guides in read the docs and in this repo again? |
Would it make sense to deprecate the RTD repo and just push the RTD site as an artifact from here? I was looking to get started on zcash/zcash today to look at the speed of the tests and I got sidetracked looking for the RTD source to fix a few small things there (it says 4.6.0 and says |
The intent would be for everything that is specifically zcashd related to be removed from the readthedocs site, and for it to point to the zcashd book for zcashd-specific documentation. It's too easy for the readthedocs site to bitrot; by moving the zcashd-related content here we can ensure it's updated when a pull request changes things that are mentioned in the docs. |
This reverts commit 70ebc09.
This is an separate from the other backporting because this was an upstream document, so isolating it helps with future backports from upstream.
0545056
to
fbdfbae
Compare
doc/wallet-backup.md
Outdated
`zcash-cli z_importwallet <path/to/exportdir/nameofbackup>` | ||
```bash | ||
$ zcash-cli z_importwallet <path/to/exportdir/nameofbackup> | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs work. HD-generated keys won't be included in the export file and therefore won't be imported; this includes all Sapling and Orchard keys generated since and including zcashd 4.7.0.
doc/wallet-backup.md
Outdated
`zcash-cli help importprivkey` | ||
```bash | ||
$ zcash-cli help importprivkey | ||
``` | ||
|
||
### Using `dumpwallet` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is currently disabled by default.
doc/tor.md
Outdated
``` | ||
|
||
Note that zcashd does not yet support Onion v3 addresses, but will do so before | ||
v2 addresses are removed from Tor. See [this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK with comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK. There is more we should do with these, but we can do that in subsequent PRs once we've seen how it fits into the book.
This reverts 70ebc09 which
had previously moved zcashd documentation to zcash.readthedocs.io, backports changes that had
been made on the readthedocs site, and moves the update documentation into the zcashd book.