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

21 lines
826 B
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)
- [User Documentation](user.md)
- [Installing Zebra](user/install.md)
- [Running Zebra](user/run.md)
- [Tracing Zebra](user/tracing.md)
- [Zebra Metrics](user/metrics.md)
- [Developer Documentation](dev.md)
- [Contribution Guide](CONTRIBUTING.md)
- [Design Overview](dev/overview.md)
- [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)
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
- [Diagrams](dev/diagrams.md)
- [Network Architecture](dev/diagrams/zebra-network.md)
- [zebra-checkpoints](dev/zebra-checkpoints.md)
- [API Reference](api.md)