Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added a readme and a Plank logo

  • Loading branch information...
commit 6e7253aacb15e6d46fdb5975a000769b251f74a2 1 parent c942228
@Emerson Emerson authored
View
18 README
@@ -0,0 +1,18 @@
+<h2>The Problem</h2>
+
+<p>
+Every developer knows that a framework lives and dies by its documentation. Proper documentation makes things easy to learn, ensuring that a framework will attract new users and remain relevant and healthy. For this reason, I've been consistently surprised by the poor quality of the CakePHP documentation. Don't get me wrong, if you're willing to spend some time searching you can usually find what you're looking for – but the process of "drilling down" into the "Cake Book" can leave one feeling frustrated. To help curb this frustration I've put together a little application that will hopefully make browsing the Cake Book a little more intuitive.
+</p>
+
+<h2>Introducing, FrostedDocs for CakePHP</h2>
+
+<p>
+I'm pleased to introduce "FrostedDocs for CakePHP", a webkit (chrome or safari) mini-app that provides a more useful way of browsing the CakePHP book. Specifically, this app solves the following problems:
+</p>
+
+<ul>
+ <li>No more aimless browsing through sub-menu after sub-menu. FrostedDocs will (after ~20 minutes) preload the entire Cake Book menu, allowing you to instantly drill down without painful page reloads. Once the menu is finished loading you may save it to your localStore.</li>
+ <li>Cache documentation pages within your HTML5 capable browser using localStore.</li>
+ <li>Avoid the AdSense eyesore that currently inhabits the Cake Book.</li>
+ <li>Easily theme the documentation to your liking.</li>
+</ul>
View
12 css/app.css
@@ -51,6 +51,16 @@ body {
border-radius: 8px;
}
+#plank {
+ position: absolute;
+ top: 1px;
+ right: 20px;
+}
+
+#topmenu #plank:hover {
+ background: transparent;
+}
+
#ajax-controls {
position: absolute;
left: 45px;
@@ -58,7 +68,7 @@ body {
#localstore-controls {
position: absolute;
- right: 0px;
+ right: 80px;
}
#wrapper {
View
BIN  images/plank-background.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  images/plank.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
5 index.html
@@ -14,7 +14,7 @@
<link rel="stylesheet" type="text/css" href="css/code.css" />
<link rel="stylesheet" type="text/css" href="css/app.css" />
- <title>CakeDocs Extreme</title>
+ <title>FrostedDocs - CakePHP Documentation Evolved</title>
</head>
@@ -24,6 +24,8 @@
<img id="loader" src="images/loader.gif" width="16" height="16" alt="loading..." />
+ <a id="plank" href="http://www.plankdesign.com"><img src="images/plank.png" width="49" height="19" /></a>
+
<ul id="ajax-controls">
<li><a id="start" href="#">Fetch Menu</a></li>
<li><a id="pause" href="#">Abort</a></li>
@@ -31,7 +33,6 @@
<ul id="localstore-controls">
<li><a id="save" href="#">Save to Localstore</a></li>
- <li><a id="load" href="#">Load from Localstore</a></li>
<li><a id="clear" href="#">Clear Localstore</a></li>
</ul>
Please sign in to comment.
Something went wrong with that request. Please try again.