We didn't really write much API docs yet (bad us) but the idea is to use docker js.<div><br></div><div><a href="http://jbt.github.io/docker/src/docker.js.html">http://jbt.github.io/docker/src/docker.js.html</a></div><div>
<br></div><div>In theory this should allow free form docs while keeping them inside the code, which is usually good to avoid them becoming stale.</div><div><br>On Tuesday, 26 November 2013, Rogelio Mita  wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div dir="ltr"><div>Hi!</div><div><br></div><div>I was doing use of dictstore API on my POC web activity and I found in the position to want do: "save data when closing activity", trying things and reading source code I found this paragraph that helped me to do this task:</div>


<div><br></div><div><a href="https://github.com/sugarlabs/sugar-web/blob/master/activity/activity.js#L30" target="_blank">https://github.com/sugarlabs/sugar-web/blob/master/activity/activity.js#L30</a><br></div><div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">


// An activity that handles 'activityStop' can also call<br>// event.preventDefault() to prevent the close, and explicitly<br>// call activity.close() after storing.</blockquote><div><br></div><div>This information is very useful, my propose is start this thread to discuss the way to documenting Storage API.</div>


<div>The first proposal/task:</div><div><ul><li>Make a section on <a href="http://developer.sugarlabs.org/" target="_blank">http://developer.sugarlabs.org/</a> called "Storing information" or something like, and:</li>
<ul><li>Migrate <a href="https://github.com/sugarlabs/sugar-web/blob/master/activity/activity.js#L30" target="_blank">this comment</a> to this doc page</li>

<li>Make a test or example that describe this situation: "Save when closing we activity"</li></ul><li>Fetch comments similar to that on source code and do same flow</li><li>Make a introduction of "dictstore API" and document it</li>


</ul>Regards!</div><br clear="all"><div><br></div>-- <br>Roger<div><br><div><a href="http://activitycentral.com/" target="_blank">Activity Central</a></div></div>
</div></div>
</blockquote></div><br><br>-- <br>Daniel Narvaez<br><br>