Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite documentation and add to repo #1154

Merged
merged 1 commit into from Aug 2, 2012

Conversation

Projects
None yet
5 participants
@necolas
Copy link
Member

commented Jul 31, 2012

Include all documentation related to the project and its code. This
ensures that docs are available offline and that any future download
will have docs that relevant for the version in use.

This change involves a documentation rewrite to update, simplify,
clarify, and consolidate it.

@mathiasbynens

This comment has been minimized.

Copy link
Member

commented Jul 31, 2012

Nice work!

@mathiasbynens

View changes

doc/README.md Outdated
of your site/app in various production environments.

* [Server configs](https://github.com/h5bp/server-configs) - Configs for
non-Apache servers.

This comment has been minimized.

Copy link
@mathiasbynens

mathiasbynens Jul 31, 2012

Member

Can haz em dashes here?

@mathiasbynens

View changes

doc/contribute.md Outdated
> 2. This is the second step
> 3. Further steps, etc.
>
> `<url>` - a link to the reduced test case

This comment has been minimized.

Copy link
@mathiasbynens

mathiasbynens Jul 31, 2012

Member

Here too.

@mathiasbynens

View changes

doc/contribute.md Outdated

## Pull requests

Good pull requests - patches, improvements, new features - are a fantastic

This comment has been minimized.

Copy link
@mathiasbynens

mathiasbynens Jul 31, 2012

Member

And here too.

@necolas

This comment has been minimized.

Copy link
Member Author

commented Aug 1, 2012

24 hours for more feedback before I merge this in. Thanks.

@paulirish

This comment has been minimized.

Copy link
Member

commented Aug 1, 2012

Nice work sir!

doc/html.md Outdated
The Google CDN version of the jQuery JavaScript library is referenced towards
the bottom of the page using a protocol-independent path (read more about this
in the [FAQ](faq.md). A local fallback of jQuery is included for rare instances
when teh CDN version might not be available, and to facilitate offline

This comment has been minimized.

Copy link
@sindresorhus
doc/html.md Outdated
legacy versions of IE. While you may or may not choose to use this technique in
your project code, HTML5 Boilerplate's default CSS does not rely on it.

When using the conditonal classes technique, applying classes to the `html`

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

conditional

page weight and accelerate the user experience.


### Cachebusting

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

Cache busting

to do is add the timestamp number to the filename in your HTML source. The
`.htaccess` directive will serve up the proper file.

Traditional cachebusting involved adding a query string to the end of your

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

cache busting

doc/faq.md Outdated

### How to I prevent phone numbers looking twice as large and having a Skype highlight?

If this is occuring, it is because a user has the Skype browser extension

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

occurring

doc/faq.md Outdated
browser will attempt to fetch the file from your local file system. We
recommend that you use a local server to test your pages (or Dropbox). This can
be done using Python by running `python -m SimpleHTTPServer` from your local
directory, using Ruby by installing and runing

This comment has been minimized.

Copy link
@sindresorhus
scrollPercent = Math.round(100 * ($window.height() + $window.scrollTop())/$document.height());
if (scrollPercent > 90 && !isDuplicateScrollEvent) { //page scrolled to 90%
isDuplicateScrollEvent = 1;
_gaq.push(['_trackEvent', 'scrool',

This comment has been minimized.

Copy link
@sindresorhus
extremely simple and immediately viewable example of the issue.

4. **Include a live example** &mdash; provide a link to your reduced test case
when appropriate (e.g. if the issue is related to frond-end technologies).

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

front-end

@necolas

This comment has been minimized.

Copy link
Member Author

commented Aug 1, 2012

Thanks for catching a bunch of old and new typos!


### Hide pages from search engines

According to Heather Champ, former community manager at flickr, you should not

This comment has been minimized.

Copy link
@sindresorhus

### Prompt users to switch to "Desktop Mode" in IE10 Metro

IE10 does not support plugins, such as Flash, in Metro Mode. If your site

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

Metro mode

doc/faq.md Outdated
that scripts at the bottom are the right move.


### How can I integrate [TwitterBootstrap](http://twitter.github.com/bootstrap/) with HTML5 Boilerplate?

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

Twitter Bootstrap


You've got a couple of options that depend on how you installed Apache.

1. **Wampserver**. This is by far the simplest option. If you have installed

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

WampServer

`sudo a2enmod setenvif headers deflate filter expires rewrite include`

1. Restart apache by using the following command so the new configuration takes
affect.

This comment has been minimized.

Copy link
@sindresorhus
FileETag None
```

Entity tags (ETags) are a mechanism that web servers and browsers use to

This comment has been minimized.

Copy link
@sindresorhus
that make them unique to a specific server hosting a site. ETags won't match
when a browser gets the original component from one server and later tries to
validate that component on a different server, a situation that is all too
common on Web sites that use a cluster of servers to handle requests. By

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

websites

more like this below

doc/js.md Outdated
## main.js

This file can be used to contain or reference your site/app JavaScript code.
For larger projects, instead `main.js` you can make use of a JavaScript module

This comment has been minimized.

Copy link
@sindresorhus

sindresorhus Aug 1, 2012

Member

instead of

@sindresorhus

This comment has been minimized.

Copy link
Member

commented Aug 1, 2012

Really nice work on this @necolas 🎀
I especially like the contribution docs. Should be standard in every big project.

@necolas

This comment has been minimized.

Copy link
Member Author

commented Aug 1, 2012

Thanks again. Will fix these when I get home. The contribution section is a simplified version of my issue-guidelines repo.

doc/faq.md Outdated
other](http://www.quora.com/Is-Bootstrap-a-complement-OR-an-alternative-to-HTML5-Boilerplate-or-viceversa/answer/Nicolas-Gallagher).


### How to I prevent phone numbers looking twice as large and having a Skype highlight?

This comment has been minimized.

Copy link
@s10wen

s10wen Aug 2, 2012

Contributor

How *do I

Rewrite documentation and add to repo
Include all documentation related to the project and its code. This
ensures that docs are available offline and that any future download
will have docs that relevant for the version in use.

This change involves a documentation rewrite to update, simplify,
clarify, and consolidate it.

@necolas necolas merged commit e63107e into master Aug 2, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.