Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Rename doc/README to doc/TOC

Avoid the problem with links in a directory README on github.com. GitHub
displays a directory's README when at the dir level, which results in
incorrect URLs when links are using relative paths. This is causing some
confusion for people who browse to the documentation on GitHub and try
to browse the docs from the automatically displayed README.
  • Loading branch information...
commit 0dcd9d120e6027427c3fca3ecbf0c796b0cce4fd 1 parent cb0bb16
@necolas necolas authored
View
2  README.md
@@ -50,7 +50,7 @@ Choose one of the following options:
## Documentation
Take a look at the [documentation table of
-contents](/h5bp/html5-boilerplate/blob/master/doc/README.md). This
+contents](/h5bp/html5-boilerplate/blob/master/doc/TOC.md). This
documentation is bundled with the project, which makes it readily available for
offline reading and provides a useful starting point for any documentation
you want to write about your project.
View
0  doc/README.md → doc/TOC.md
File renamed without changes
View
2  doc/contribute.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# Contributing to HTML5 Boilerplate
View
2  doc/crossdomain.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# crossdomain.xml
View
2  doc/css.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# The CSS
View
2  doc/extend.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# Extend and customise HTML5 Boilerplate
View
2  doc/faq.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# Frequently asked questions
View
2  doc/htaccess.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# .htaccess
View
2  doc/html.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# The HTML
View
2  doc/js.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# The JavaScript
View
3  doc/misc.md
@@ -1,4 +1,5 @@
-[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation table of contents](README.md)
+[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
+table of contents](TOC.md)
# Miscellaneous
View
2  doc/usage.md
@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
-table of contents](README.md)
+table of contents](TOC.md)
# Usage
Please sign in to comment.
Something went wrong with that request. Please try again.