index.html

<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="chrome=1">
    <title>Documentation by statedecoded</title>

    <link rel="stylesheet" href="stylesheets/styles.css">
    <link rel="stylesheet" href="stylesheets/pygment_trac.css">
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
  </head>
  <body>
    <div class="wrapper">
      <header>
        <h1>Documentation</h1>
        <p>Guides to using The State Decoded, whether deploying a site or using the data from one.</p>

        <p class="view"><a href="https://github.com/statedecoded/documentation">View the Project on GitHub <small>statedecoded/documentation</small></a></p>


        <ul>
          <li><a href="https://github.com/statedecoded/documentation/zipball/master">Download <strong>ZIP File</strong></a></li>
          <li><a href="https://github.com/statedecoded/documentation/tarball/master">Download <strong>TAR Ball</strong></a></li>
          <li><a href="https://github.com/statedecoded/documentation">View On <strong>GitHub</strong></a></li>
        </ul>
      </header>
	<section>

		<h2><a name="introduction" class="anchor" href="#introduction"><span class="octicon octicon-link"></span></a><a href="introduction.html">Introduction</a></h2>
		<p>An introduction to The State Decoded—what it does, why you might want to use it, what you need to get started.</p>

        <h2><a name="installation" class="anchor" href="#installation"><span class="octicon octicon-link"></span></a><a href="installation.html">Installation</a></h2>
		<p>How to get a State Decoded site up and running.</p>

        <h2><a name="config" class="anchor" href="#config"><span class="octicon octicon-link"></span></a><a href="config.html">Configuration</a></h2>
		<p>Detailed descriptions of each setting in the configuration file, <code>config.inc.php</code>.</p>

		<h2><a name="xml-format" class="anchor" href="#xml-format"><span class="octicon octicon-link"></span></a><a href="xml-format.html">XML Format</a></h2>
		<p>Description of the The State Decoded's XML format, which the platform uses as a simple, common format to import legal codes. Also, how to convert other XML formats into The State Decoded's format using provided XSLT.</p>

		<h2><a name="search" class="anchor" href="#search"><span class="octicon octicon-link"></span></a><a href="search.html">Search Engine</a></h2>
		<p>Instructions about how to configure and tune Solr, the search system that powers aspects of The State Decoded, and suggestions about how to use software other than Solr, such as a hosted search system.</p>

		<h2><a name="parser" class="anchor" href="#parser"><span class="octicon octicon-link"></span></a><a href="parser.html">How the Parser Works</a></h2>
		<p>A narrative description of how the parser works, for those who want to modify it to import legal information in a format other than The State Decoded's XML format.</p>

		<h2><a name="templates" class="anchor" href="#templates"><span class="octicon octicon-link"></span></a><a href="templates.html">Customizing The Site</a></h2>
		<p>How to customize the appearance of a State Decoded website.</p>

		<h2><a name="api" class="anchor" href="#api"><span class="octicon octicon-link"></span></a><a href="api.html">API</a></h2>
		<p>How to interact with the API, including getting a key, a list of methods, information on all fields in responds to each method, and handling errors.</p>

    <h2><a name="cli" class="anchor" href="#cli"><span class="octicon octicon-link"></span></a><a href="cli.html">Command Line Tool</a></h2>
    <p>How to use The State Decoded command line tool to import data, manipulate the database, and perform other common tasks.</p>

		<h2><a name="coding-standards" class="anchor" href="#coding-standards"><span class="octicon octicon-link"></span></a><a href="coding-standards.html">Coding Standards</a></h2>
		<p>The basic practices and norms employed with The State Decoded's codebase, for those who want to contribute.</p>
		
		<h2><a name="release-process" class="anchor" href="#release-process"><span class="octicon octicon-link"></span></a><a href="release-process.html">Release Process Checklist</a></h2>
		<p>A checklist of steps to be taken before releasing a new version of The State Decoded.</p>

	</section>
      <footer>
        <p>This project is maintained by <a href="https://github.com/statedecoded">statedecoded</a></p>
        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
      </footer>
    </div>
    <script src="javascripts/scale.fix.js"></script>
    
</body>
</html>