From 9e9aa920442f01b6a0e7150aa19d24d29092da2c Mon Sep 17 00:00:00 2001 From: Ben Word Date: Tue, 2 Oct 2012 18:41:19 -0500 Subject: [PATCH] Fix #561 - Use TOC.md for documentation TOC --- README.md | 4 ++-- doc/{README.md => TOC.md} | 0 doc/activation.md | 4 ++-- doc/cleanup.md | 14 +++++++------- doc/extend.md | 2 +- doc/faq.md | 2 +- doc/lib.md | 8 ++++---- doc/plugins.md | 4 ++-- doc/rewrites.md | 4 ++-- doc/templates.md | 4 ++-- doc/usage.md | 2 +- doc/wrapper.md | 2 +- 12 files changed, 25 insertions(+), 25 deletions(-) rename doc/{README.md => TOC.md} (100%) diff --git a/README.md b/README.md index 349078a..c3f7fac 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Edit `lib/config.php` to enable support for major functionality and to define co ## Documentation -Take a look at the [documentation table of contents](/retlehs/roots/blob/master/doc/README.md). +Take a look at the [documentation table of contents](/retlehs/roots/blob/master/doc/TOC.md). ## Features @@ -34,7 +34,7 @@ Everyone is welcome to help [contribute](/retlehs/roots/blob/master/CONTRIBUTING * Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines)) * Suggesting new features -* Writing or editing [docs](/retlehs/roots/blob/master/doc/README.md) +* Writing or editing [docs](/retlehs/roots/blob/master/doc/TOC.md) * Writing or refactoring code * Fixing [issues](https://github.com/retlehs/roots/issues) * Replying to questions on the [mailing list](http://groups.google.com/group/roots-theme) diff --git a/doc/README.md b/doc/TOC.md similarity index 100% rename from doc/README.md rename to doc/TOC.md diff --git a/doc/activation.md b/doc/activation.md index f626413..c8d6dfc 100644 --- a/doc/activation.md +++ b/doc/activation.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Theme activation @@ -7,7 +7,7 @@ Theme activation is handled by `lib/activation.php`. After you activate Roots from the WordPress admin you'll be redirected to an activation options page where you can choose to: -### Create static front page +### Create static front page Create a page called Home and set it to be the static front page. This is normally handled from the Reading settings. diff --git a/doc/cleanup.md b/doc/cleanup.md index 541e05c..1c0ae42 100644 --- a/doc/cleanup.md +++ b/doc/cleanup.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Clean up @@ -20,13 +20,13 @@ Clean up is handled by `lib/cleanup.php`. Major parts include: ### Root relative URLs -Root relative URLs are enabled from `lib/config.php`. +Root relative URLs are enabled from `lib/config.php`. Return URLs such as `/assets/css/app.css` instead of `http://example.com/assets/css/app.css`. ### Wrap embedded media as suggested by Readability -The [Readability article publishing guidelines](http://www.readability.com/developers/guidelines#publisher) suggest wrapping embedded media with a class of `entry-content-asset`. +The [Readability article publishing guidelines](http://www.readability.com/developers/guidelines#publisher) suggest wrapping embedded media with a class of `entry-content-asset`. ### Use HTML5 figure and figcaption for images with captions @@ -53,22 +53,22 @@ Walker_Nav_Menu (WordPress default) example output:
  • Home
  • Sample PageHome
  • Sample Page
    • - + If using the Bootstrap top navbar (enabled in `lib/config.php`), the proper markup is added to the items and the depth is restricted to 2 (Bootstrap doesn't support multi-level dropdowns). -Instead of the many different active class varities that WordPress usually uses, only `active` is returned on active items. +Instead of the many different active class varities that WordPress usually uses, only `active` is returned on active items. ### Remove unnecessary self-closing tags Self-closing tags aren't necessary with HTML5. They're removed on: 1. `get_avatar()` (``) -2. `comment_id_fields()` (``) +2. `comment_id_fields()` (``) 3. `post_thumbnail_html()` (``) ### Don't return the default description in the RSS feed if it hasn't been changed diff --git a/doc/extend.md b/doc/extend.md index 7e14184..594d225 100755 --- a/doc/extend.md +++ b/doc/extend.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Extend and customize Roots Here is some useful advice for how you can make your project with Roots even better. diff --git a/doc/faq.md b/doc/faq.md index 3ca8bb0..b699e5d 100755 --- a/doc/faq.md +++ b/doc/faq.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Frequently asked questions diff --git a/doc/lib.md b/doc/lib.md index 153991e..fa89bbf 100644 --- a/doc/lib.md +++ b/doc/lib.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Theme library @@ -65,7 +65,7 @@ This file is a placeholder for you to put in [custom post types](http://codex.wo ### scripts.php -This file handles all of the CSS and JavaScript. +This file handles all of the CSS and JavaScript. ### sidebar.php @@ -80,7 +80,7 @@ Stylesheets are enqueued in the following order: 3. `/theme/assets/css/app.css` 4. `/child-theme/style.css` (if a child theme is activated) -`app.css` should be used for your site specific styling. +`app.css` should be used for your site specific styling. If you're using LESS, make sure you compile the files to the proper locations: @@ -100,7 +100,7 @@ jQuery is loaded in `head.php` using the same method from HTML5 Boilerplate: gra `plugins.js` contains a minified version of all the latest Bootstrap plugins. -Learn about `plugins.js` and `main.js` in the HTML5 Boilerplate [JavaScript docs](https://github.com/h5bp/html5-boilerplate/blob/master/doc/js.md). +Learn about `plugins.js` and `main.js` in the HTML5 Boilerplate [JavaScript docs](https://github.com/h5bp/html5-boilerplate/blob/master/doc/js.md). ##### jQuery in the footer diff --git a/doc/plugins.md b/doc/plugins.md index 22f3ad9..33e3e8d 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Recommended Plugins @@ -10,7 +10,7 @@ table of contents](README.md) | [**WordPress SEO**](http://yoast.com/wordpress/seo/) | Yoast's all in one SEO solution: titles, meta descriptions, XML sitemaps, breadcrumbs & more. | [**WP Super Cache**](http://wordpress.org/extend/plugins/wp-super-cache/) | WP Super Cache is a static caching plugin that generates HTML files. | [**W3 Total Cache**](http://wordpress.org/extend/plugins/w3-total-cache/) | Improve site performance and user experience via caching. -| [Analytics 360](http://wordpress.org/extend/plugins/analytics360/) | Pull Google Analytics and MailChimp data directly into your dashboard. +| [Analytics 360](http://wordpress.org/extend/plugins/analytics360/) | Pull Google Analytics and MailChimp data directly into your dashboard. | [Custom Metaboxes & Fields](https://github.com/jaredatch/Custom-Metaboxes-and-Fields-for-WordPress) | Easily create metaboxes with custom fields. | [Front-end Editor](http://scribu.net/wordpress/front-end-editor) | A WordPress plugin that enables "edit in place" functionality on your site. | [Options Framework](https://github.com/devinsays/options-framework-plugin) | An Options Panel Framework to help speed theme development. diff --git a/doc/rewrites.md b/doc/rewrites.md index a4a0864..2a06b8f 100644 --- a/doc/rewrites.md +++ b/doc/rewrites.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Rewrites @@ -27,7 +27,7 @@ First remove the `if` statement that wraps everything, since if you're not on Ap rewrite ^/plugins/(.*)$ /wp-content/plugins/$1 last; break; } - + ### Lighttpd url.rewrite-once = ( diff --git a/doc/templates.md b/doc/templates.md index 2289459..b09d57a 100644 --- a/doc/templates.md +++ b/doc/templates.md @@ -1,11 +1,11 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Theme templates ### comments.php -The comments template wraps each comment in an `
    ` and the vCard microformat is used for comment author information. +The comments template wraps each comment in an `
    ` and the vCard microformat is used for comment author information. ### content.php diff --git a/doc/usage.md b/doc/usage.md index 1a80158..5c7fcbb 100755 --- a/doc/usage.md +++ b/doc/usage.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Usage diff --git a/doc/wrapper.md b/doc/wrapper.md index 9ee4623..b913923 100644 --- a/doc/wrapper.md +++ b/doc/wrapper.md @@ -1,5 +1,5 @@ [Roots Theme homepage](http://www.rootstheme.com/) | [Documentation -table of contents](README.md) +table of contents](TOC.md) # Theme wrapper