blob: 2dc4adcdd58364d9f3801432a9efb4ef48e4cb43 [file] [log] [blame]
<h1>Documentation</h1>
<p>The documentation is mostly in the project's <a href="/gw/doc">doc/
directory</a> or in the source itself. It's now being promoted to
HTML, though:</p>
<h2>For Users</h2>
<ul>
<li><a href="/docs/server-config">Server Config</a>: how to configure your Camlistore server</li>
<li><a href="/cmd/">Commands</a>: Camlistore command-line tools</li>
</ul>
<h2>For Developers</h2>
<ul>
<li><a href="/docs/arch">Architecture</a>: the pieces, layers, and how they interact</li>
<li><a href="/docs/principles">Principles</a>: our base principles, goals, assumptions</li>
<li><a href="/docs/terms">Terminology</a>: let's agree on terms to stay sane</li>
<li><a href="/docs/uses">Use Cases</a>: what one might do with all this (or at least our aspirations)</li>
<li><a href="/docs/schema">Schema</a>: how we model data in Camlistore</li>
<li><a href="/docs/json-signing">JSON Signing</a></li>
<li><a href="/docs/sharing">Sharing</a></li>
<li><a href="/pkg/">Packages</a>: internal API documentation</li>
<li><a href="/docs/prior-art">Prior Art</a>: other projects doing similar stuff</li>
<li><a href="/docs/contributing">Contributing</a>: how to help</li>
</ul>
<h2>Releases</h2>
<ul>
<li><a href="release/0.1">0.1 ("Grenoble")</li>
</ul>