zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zebra/book/src/SUMMARY.md

49 lines
2.3 KiB
Markdown
Raw Normal View History

Add skeleton of eventual zebra book (#653) * Add skeleton of eventual zebra book * reorg sections * restore file and reorg book a little * try setting up a firebase deployment * allow firebase ci to work on test * download mdbook * fix book path * use newer version of mdbook * remove event hook for book branch pre merge * Apply suggestions from code review Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca> Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca>
2020-07-17 20:15:50 -07:00
# Summary
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
[Zebra](README.md)
change(docs): Refactor the system requirements (#6697) * Simplify the summary in the book * Refactor the system requirements * Apply suggestions from code review Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com> --------- Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
2023-05-18 14:25:05 -07:00
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
- [User Documentation](user.md)
change(docs): Refactor the system requirements (#6697) * Simplify the summary in the book * Refactor the system requirements * Apply suggestions from code review Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com> --------- Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com>
2023-05-18 14:25:05 -07:00
- [System Requirements](user/requirements.md)
Zebra book additions (#6683)
2023-05-16 16:53:30 -07:00
- [Supported Platforms](user/supported-platforms.md)
- [Platform Tier Policy](user/target-tier-policies.md)
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
- [Installing Zebra](user/install.md)
- [Running Zebra](user/run.md)
docs: add user documentation on how to use Zebra with docker (#5504) * docs: add user documentation on how to use Zebra with docker Motivation: We don't have a user documentation on how to use/deploy Zebra using our the Dockerfile available in our repository or were the images are being hosted Solution: Add user documentation explaining how to pull the image from the Docker Hub or how to build it locally. With extra information on which images we're hosting and where we're hosting it * docs(docker): use existing getting started header * Update book/src/user/docker.md Co-authored-by: Arya <aryasolhi@gmail.com> * docs(docker): add build alternative instructions from Docker * docs: add docker documentation to Rust doc sidebar * docs: update checklist with docker user documentation * Update README.md Co-authored-by: teor <teor@riseup.net> * Update new refs to rc.1 Co-authored-by: Arya <aryasolhi@gmail.com> Co-authored-by: teor <teor@riseup.net> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2022-10-31 22:47:37 -07:00
- [Zebra with Docker](user/docker.md)
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
- [Tracing Zebra](user/tracing.md)
- [Zebra Metrics](user/metrics.md)
docs(lightwalletd): add a lightwalletd tutorial (#4526) * add a lightwalletd tutorial * apply simplifications Co-authored-by: teor <teor@riseup.net> * change `zebra.toml` location * update go installation * remove optional config sections * remove nginx section * use another location for `lightwalletd` binary * change `lightwalletd` start command * typo * change sentence * improve run the wallet command * remove space Co-authored-by: teor <teor@riseup.net>
2022-06-01 16:13:18 -07:00
- [Lightwalletd](user/lightwalletd.md)
docs(command): zebra download (#5901) * document zebra download command * Apply suggestions from code review Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com> Co-authored-by: teor <teor@riseup.net> * iremove log Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com> Co-authored-by: teor <teor@riseup.net>
2023-01-18 21:21:19 -08:00
- [zk-SNARK Parameters](user/parameters.md)
feat(docs): Add mining instructions to the zebra book (#6199) * add mining section to the zebra book * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * add more suggestions from review --------- Co-authored-by: teor <teor@riseup.net>
2023-02-22 16:12:29 -08:00
- [Mining](user/mining.md)
Add instructions for mining with s-nomp to Zebra book (#6220) * Add instructions for mining with s-nomp to Zebra book * Update book/src/SUMMARY.md nest under mining Co-authored-by: Arya <aryasolhi@gmail.com> * Fixes from review --------- Co-authored-by: Arya <aryasolhi@gmail.com>
2023-02-27 14:30:37 -08:00
- [Testnet Mining with s-nomp](user/mining-testnet-s-nomp.md)
add(Docker): Docs for mining with Docker (#7179) * Add docs for mining with Docker * Refactor the docs for mining with Docker * Add a note on syncing
2023-07-25 15:51:05 -07:00
- [Mining with Zebra in Docker](user/mining-docker.md)
Add shielded-scan.md to the index (#8095)
2023-12-12 15:51:52 -08:00
- [Shielded Scanning](user/shielded-scan.md)
add(scan): Adds gRPC reflection and documents how to use the zebra-scan gRPC server (#8288) * adds tonic-reflection * adds listen_addr to log * Adds user guide for scan server to zebra book * fixes typo * Applies suggestions from code review * update link Co-authored-by: Marek <mail@marek.onl> --------- Co-authored-by: Alfredo Garcia <oxarbitrage@gmail.com> Co-authored-by: Marek <mail@marek.onl>
2024-02-22 10:51:14 -08:00
- [Shielded Scanning gRPC Server](user/shielded-scan-grpc-server.md)
feat(docs): Add elasticsearch section to Zebra book (#6295) * add elasticsearch section to zebra book * codespell
2023-03-14 10:06:43 -07:00
- [Kibana blockchain explorer](user/elasticsearch.md)
add a testnet fork tutorial (#7995)
2023-11-26 13:34:24 -08:00
- [Forking the Zcash Testnet with Zebra](user/fork-zebra-testnet.md)
fix openapi now showing up in book summary (#8357)
2024-03-18 15:05:22 -07:00
- [OpenAPI specification](user/openapi.md)
change(docs): Update User Docs (#6733) * Move releases info to `Building Zebra` * Move Zebra use-cases to `Using Zebra` * Point the links in Zebra use-cases to docs * Move the contents of `Release Candidates` * Refactor the `System Requirements` link * Update the syncing times * Update notes on performance * Move data usage to `System Requirements` * Remove "building Zebra" from lightwalletd docs I think we can assume people will follow the previous parts of the docs for how to build Zebra. * Move lightwalletd details from `README.md` to docs `README.md` already mentions lightwalletd from the `Using Zebra` section, and refers the reader to the docs where the details were moved and refactored. * Mention `lightwalletd` and mining in Running Zebra * Move Troubleshooting to its own file * Move "Improving Performance" to its own file * Move instructions for ARM to "Installing Zebra" * Reword the Testnet sync duration description Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com> * Move "Improving Performance" to "Troubleshooting" * Remove the Testnet unreliability caveat --------- Co-authored-by: Pili Guerra <mpguerra@users.noreply.github.com>
2023-05-23 06:18:57 -07:00
- [Troubleshooting](user/troubleshooting.md)
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
- [Developer Documentation](dev.md)
- [Contribution Guide](CONTRIBUTING.md)
- [Design Overview](dev/overview.md)
change(doc): Document how to upgrade the database format (#7261) * Move the state format into a new doc * Add upgrade instructions * Link to the format upgrade docs from the upgrade code * Fix typo Co-authored-by: Marek <mail@marek.onl> --------- Co-authored-by: Marek <mail@marek.onl>
2023-07-19 18:50:25 -07:00
- [Diagrams](dev/diagrams.md)
- [Network Architecture](dev/diagrams/zebra-network.md)
- [Upgrading the State Database](dev/state-db-upgrades.md)
Zebra book additions (#6683)
2023-05-16 16:53:30 -07:00
- [Zebra versioning and releases](dev/release-process.md)
change(doc): Document how to upgrade the database format (#7261) * Move the state format into a new doc * Add upgrade instructions * Link to the format upgrade docs from the upgrade code * Fix typo Co-authored-by: Marek <mail@marek.onl> --------- Co-authored-by: Marek <mail@marek.onl>
2023-07-19 18:50:25 -07:00
- [Continuous Integration](dev/continuous-integration.md)
- [Continuous Delivery](dev/continuous-delivery.md)
- [Generating Zebra Checkpoints](dev/zebra-checkpoints.md)
- [Doing Mass Renames](dev/mass-renames.md)
docs(build): Add ECC dependencies documentation (#7794) * add ecc dependencies documentation * add `cargo deny` suggestion to deny.toml section Co-authored-by: Arya <aryasolhi@gmail.com> * change sententence syntax Co-authored-by: Arya <aryasolhi@gmail.com> * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * move consistency check --------- Co-authored-by: Arya <aryasolhi@gmail.com> Co-authored-by: teor <teor@riseup.net>
2023-10-24 20:27:16 -07:00
- [Updating the ECC dependencies](dev/ecc-updates.md)
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
- [Zebra RFCs](dev/rfcs.md)
- [Pipelinable Block Lookup](dev/rfcs/0001-pipelinable-block-lookup.md)
rfc: initial inventory tracking (#952) * rfc: initial inventory tracking This just describes the design, not the design alternatives. * rfc: finish inventory tracking rfc Also assign it #3. The async script verification RFC should have had a number assigned before merging but it didn't. I don't want to fix that in this PR because I don't want those changes to block on each other. The fix is to (1) document the RFC flow better and (2) add issue templates for RFCs. * rfc: touch up inventory tracking rfc * rfc: prune inventory entries generationally. Based on a suggestion by @yaahc. * Update book/src/dev/rfcs/0003-inventory-tracking.md Co-authored-by: Jane Lusby <jlusby42@gmail.com>
2020-08-28 14:19:18 -07:00
- [Parallel Verification](dev/rfcs/0002-parallel-verification.md)
- [Inventory Tracking](dev/rfcs/0003-inventory-tracking.md)
rfc: add number to script verification rfc
2020-08-28 17:43:08 -07:00
- [Asynchronous Script Verification](dev/rfcs/0004-asynchronous-script-verification.md)
RFC: state updates (#902) * wip Co-authored-by: Jane Lusby <jlusby42@gmail.com> * wip2: add nullifiers Co-authored-by: Jane Lusby <jlusby42@gmail.com> * Update book/src/dev/rfcs/0003-state-updates.md Co-authored-by: teor <teor@riseup.net> * Move to RFC number 5 * rfc: add PR link to state update RFC * rfc: change state RFC to store blocks by height. The rationale for this change is described in the document: it means that we write blocks only to one end of the Sled tree, and hopefully helps us with spatial access patterns. This should help alleviate a major cause of memory use in Zebra's current WIP Sled structure, which is that: - blocks are stored in random, sparse order (by hash) in the B-tree; - the `Request::GetDepth` method opens the entire block store and queries a random part of its block data to determine whether a hash is present; - if present, it deserializes the complete block data of both the given block and the current tip block, to compute the difference in block heights. This access pattern forces a large amount of B-tree data to remain resident, and could probably be avoided if we didn't do that. * rfc: add sprout and sapling anchors to sled trees. Co-authored-by: Deirdre Connolly <deirdre@zfnd.org> * rfc: fill in details of state service requests. * rfc: extract commit process from API description * rfc: add anchor parameters to CommitBlock. These have to be computed by a verifier, so passing them as parameters means we don't recompute them. * WIP for in memory state structs * tweeks from end of session with henry * more updates from pairing * rewrite non-finalized state sections * update query instructions for each request * more updates * updates from pairing with henry * updates from proofreading solo * add guide level explanation to state rfc * add drawbacks section * Update book/src/dev/rfcs/0005-state-updates.md Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca> * Apply suggestions from code review Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca> * Update book/src/dev/rfcs/0005-state-updates.md Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca> * apply changes from code review * clarify iteration * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * apply changes from code review * Update book/src/dev/rfcs/0005-state-updates.md Co-authored-by: teor <teor@riseup.net> * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * Apply suggestions from code review Co-authored-by: Deirdre Connolly <deirdre@zfnd.org> * Apply suggestions from code review Co-authored-by: teor <teor@riseup.net> * add info about default constructing chains when forking from finalized state * Update book/src/dev/rfcs/0005-state-updates.md Co-authored-by: teor <teor@riseup.net> * move contextual verification out of Chain Co-authored-by: Jane Lusby <jlusby42@gmail.com> Co-authored-by: teor <teor@riseup.net> Co-authored-by: Deirdre Connolly <deirdre@zfnd.org> Co-authored-by: Jane Lusby <jane@zfnd.org>
2020-09-21 12:05:31 -07:00
- [State Updates](dev/rfcs/0005-state-updates.md)
Update Zebra Book TOC (#2124)
2021-05-07 06:50:51 -07:00
- [Contextual Difficulty Validation](dev/rfcs/0006-contextual-difficulty.md)
- [Zebra Client](dev/rfcs/0009-zebra-client.md)
- [V5 Transaction](dev/rfcs/0010-v5-transaction.md)
- [Async Rust in Zebra](dev/rfcs/0011-async-rust-in-zebra.md)
Add value pools design to book summary (#2520) * add value pools design to book summary
2021-07-23 06:49:47 -07:00
- [Value Pools](dev/rfcs/0012-value-pools.md)
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
- [API Reference](api.md)