explain two reservoirs of user docs and give each one a top-level headline

[Imported from Trac: page Doc, version 86]
zooko 2011-01-09 14:40:06 +00:00
parent 4ca1baad6e
commit cdc32a620d

9
Doc.md

@ -1,14 +1,14 @@
# Documentation for Tahoe-LAFS Users
There are two collections of documents for users. One collection is made up of pages on this wiki, and the other is made up of files in the 'docs' directory of the Tahoe-LAFS source tree.
Note: these links are to the 'trunk' (latest) versions of the documentation. See the 'docs' directory of a Tahoe-LAFS release for docs relating to that version.
## The Basics
## User Docs, on the wiki
* [about](http://tahoe-lafs.org/source/tahoe/trunk/docs/about.html): the Tahoe-LAFS filesystem and the unique properties that it offers
* [quickstart](http://tahoe-lafs.org/source/tahoe-lafs/trunk/docs/quickstart.html): how to get the software and set it up
* [running](http://tahoe-lafs.org/source/tahoe/trunk/docs/running.html): how to run it once it is set up
* [The 'docs' directory]source:docs/: basic instructions on using Tahoe-LAFS once it is set up.
* [Known Issues]source:docs/known_issues.rst: things you need to be aware of if you want to rely on Tahoe-LAFS to store your valuable data.
* [How To Report A Bug](HowToReportABug): We love bug reports! Here's how.
@ -21,6 +21,9 @@ Note: these links are to the 'trunk' (latest) versions of the documentation. See
* [SFTP Frontend](SftpFrontend): compatibility issues for accessing Tahoe-LAFS via SFTP
* [Tips & Tricks](TipsTricks)
## User Docs, in source code
* [The 'docs' directory]source:docs/
## A Glance Under The Hood or "Gee What Does This Button Do?"
* [configuration](http://tahoe-lafs.org/source/tahoe/trunk/docs/configuration.rst): a description of the contents of your ".tahoe" directory
* [architecture](http://tahoe-lafs.org/source/tahoe/trunk/docs/architecture.rst): a succinct overview of the whole system