new improved Doc page!

[Imported from Trac: page Doc, version 2]
zooko 2007-07-10 22:37:03 +00:00
parent 28eac49565
commit f1fe00fa07

17
Doc.md

@ -1,11 +1,18 @@
# Documentation # Documentation
* [the release notes]source:relnotes.txt, announcing the first public release on May 2, 2007 and giving a general overview of why the Tahoe project exists ## The Basics
* [architecture.txt]source:docs/architecture.txt, explaining the design decisions that have given the grid its current shape * [architecture.txt]source:docs/architecture.txt, explaining the design decisions that have given the grid its current shape
* [roadmap.txt]source:roadmap.txt, showing how the functionality has been incrementally improved so far, and what improvements we plan to make next * [roadmap.txt]source:roadmap.txt, showing how the functionality has been incrementally improved so far, and what improvements we plan to make next
* [codemap.txt]source:docs/codemap.txt, laying out the software design and the organization of the source code * [codemap.txt]source:docs/codemap.txt, laying out the software design and the organization of the source code
* [TahoeIssues](TahoeIssues) contains some discussion on open issues ## The Parade of Release Notes
* [the release notes]source:relnotes.txt@686 announcing the first public release on May 2, 2007 and giving a general overview of why the Tahoe project exists
* [the release notes]source:relnotes.txt@790 announcing the second public release on June 6, 2007
* [the release notes]source:relnotes.txt@864 announcing the third public release on June 29, 2007, including the new mutable, shareable, private directories
## Detailed Design Docs
* [TahoeIssues](TahoeIssues)/FileTree, explaining how mutable, shareable, private directories are implemented (which requires interesting crypto)
* [TahoeIssues](TahoeIssues)/PeerSelection, explaining how a Tahoe node chooses which other nodes to use for uploading and downloading files (which raises some unsolved issues in balancing scalability, robustness, performance, and simplicity)
* [TahoeIssues](TahoeIssues)/FileEncoding, explaining how we turn files into shares, with verifiable hashes; This is mostly concerned with chunking and Merkle trees.
* [TahoeIssues](TahoeIssues)/ShareEncoding, explaining how we turn a chunk into shares: Reed-Solomon, FEC, that stuff