Skip to content

Commit

Permalink
Rename doc/README to doc/TOC
Browse files Browse the repository at this point in the history
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
necolas committed Sep 16, 2012
1 parent cb0bb16 commit 0dcd9d1
Show file tree
Hide file tree
Showing 12 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down
3 changes: 2 additions & 1 deletion 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

Expand Down
2 changes: 1 addition & 1 deletion 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

Expand Down

0 comments on commit 0dcd9d1

Please sign in to comment.