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.
This commit is contained in:
Nicolas Gallagher
2012-09-16 11:45:57 +01:00
parent cb0bb16eb7
commit 0dcd9d120e
12 changed files with 12 additions and 11 deletions

View File

@@ -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 File

@@ -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 File

@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
table of contents](README.md)
table of contents](TOC.md)
# crossdomain.xml

View File

@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
table of contents](README.md)
table of contents](TOC.md)
# The CSS

View File

@@ -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 File

@@ -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 File

@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
table of contents](README.md)
table of contents](TOC.md)
# .htaccess

View File

@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
table of contents](README.md)
table of contents](TOC.md)
# The HTML

View File

@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
table of contents](README.md)
table of contents](TOC.md)
# The JavaScript

View File

@@ -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 File

@@ -1,5 +1,5 @@
[HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
table of contents](README.md)
table of contents](TOC.md)
# Usage