<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2339] 2013/rmccue/trunk: Add indexes for the documentation</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://gsoc.trac.wordpress.org/changeset/2339">2339</a></dd>
<dt>Author</dt> <dd>rmccue</dd>
<dt>Date</dt> <dd>2013-09-21 09:04:45 +0000 (Sat, 21 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add indexes for the documentation</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#2013rmccuetrunkREADMEmd">2013/rmccue/trunk/README.md</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#2013rmccuetrunkdocsREADMEmd">2013/rmccue/trunk/docs/README.md</a></li>
<li><a href="#2013rmccuetrunkdocsguidesREADMEmd">2013/rmccue/trunk/docs/guides/README.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013rmccuetrunkREADMEmd"></a>
<div class="modfile"><h4>Modified: 2013/rmccue/trunk/README.md (2338 => 2339)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/README.md 2013-09-21 09:04:38 UTC (rev 2338)
+++ 2013/rmccue/trunk/README.md 2013-09-21 09:04:45 UTC (rev 2339)
</span><span class="lines">@@ -3,6 +3,12 @@
</span><span class="cx"> run by Ryan McCue and is part of the WordPress 2013 GSoC projects.
</span><span class="cx">
</span><span class="cx">
</span><ins>+## Documentation
+Read the [plugin's documentation][docs].
+
+[docs]: https://github.com/rmccue/WP-API/tree/master/docs
+
+
</ins><span class="cx"> ## Installation
</span><span class="cx"> ### As a Plugin
</span><span class="cx"> Drop this directory in and activate it. You need to be using pretty permalinks
</span></span></pre></div>
<a id="2013rmccuetrunkdocsREADMEmd"></a>
<div class="addfile"><h4>Added: 2013/rmccue/trunk/docs/README.md (0 => 2339)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/docs/README.md (rev 0)
+++ 2013/rmccue/trunk/docs/README.md 2013-09-21 09:04:45 UTC (rev 2339)
</span><span class="lines">@@ -0,0 +1,26 @@
</span><ins>+API Documentation
+=================
+Learn how the JSON REST API works from the ground up!
+
+First time interacting with the API? Start with the [Getting Started][] guide,
+which will introduce you to the basic concepts for working with the API.
+
+From there, progress on to other [guides][] to learn in detail about parts of
+the API.
+
+Take a look at more detailed information on [post][post-routes] or
+[media][media-routes], or read about [maximizing compatibility][compatibility]
+with older clients.
+
+Dive in deeper into the [schema details][schema] to better understand the little
+details, or read about the [philosophy][] behind them. Read about the
+[implementation details][implementation] on how the API works internally.
+
+[Getting Started]: guides/getting-started.md
+[guides]: guides/README.md
+[post-routes]: routes/posts.md
+[media-routes]: routes/media.md
+[compatibility]: compatibility.md
+[schema]: schema.md
+[philosophy]: internals/philosophy.md
+[implementation]: internals/implementation.md
</ins><span class="cx">Property changes on: 2013/rmccue/trunk/docs/README.md
</span><span class="cx">___________________________________________________________________
</span></span></pre></div>
<a id="svnexecutable"></a>
<div class="addfile"><h4>Added: svn:executable</h4></div>
<ins>+*
</ins><span class="cx">\ No newline at end of property
</span><a id="2013rmccuetrunkdocsguidesREADMEmd"></a>
<div class="addfile"><h4>Added: 2013/rmccue/trunk/docs/guides/README.md (0 => 2339)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/docs/guides/README.md (rev 0)
+++ 2013/rmccue/trunk/docs/guides/README.md 2013-09-21 09:04:45 UTC (rev 2339)
</span><span class="lines">@@ -0,0 +1,15 @@
</span><ins>+Guides
+======
+So, you want to learn about the API? Where better to start than with the guides.
+Each guide will walk you through interacting with the relevant part of the API
+and mention tips and tricks for using it.
+
+* [Getting Started][]: Begin working with the API, and learn how to access basic
+ post data.
+* [Working with Posts][]: Explore more advanced usage of post-related data,
+ including filtering and additional data.
+* [Extending the API][]: Create your own API routes and endpoints in a plugin.
+
+[Getting Started]: getting-started.md
+[Working with Posts]: working-with-posts.md
+[Extending the API]: extending.md
</ins><span class="cx">Property changes on: 2013/rmccue/trunk/docs/guides/README.md
</span><span class="cx">___________________________________________________________________
</span></span></pre></div>
<a id="svnexecutable"></a>
<div class="addfile"><h4>Added: svn:executable</h4></div>
<ins>+*
</ins><span class="cx">\ No newline at end of property
</span></div>
</body>
</html>