api.jquery.com: add brief intro to homepage #333
Conversation
| @@ -2,6 +2,10 @@ | |||
| <div class="content-right listing twelve columns"> | |||
| <div id="content"> | |||
| <h1 class="page-title">jQuery API</h1> | |||
| <p>jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. If you're new to jQuery, you might be interested in the <a href="http://learn.jquery.com/">jQuery Learning Center</a> tutorials.</p> | |||
|
|
|||
| <p>This site provides API documentation for the latest verions of jQuery (1.11.2 and 2.1.3). If you're working with an older verion of jQuery, you can find its API docs in this sidebar. However, we would encourage you to upgrade to the newest version in order to receive the best support and take advantage of recent bug fixes and enhancements.</p> | |||
There was a problem hiding this comment.
This site provides API documentation for the latest verions of jQuery (1.11.2 and 2.1.3)
This isn't exactly true. This provides documentation for all versions, you just need to pay attention to the version info on each page. Anyway, APIs don't change for patch versions and keeping this up to date will drive @dmethvin nuts.
| @@ -2,6 +2,10 @@ | |||
| <div class="content-right listing twelve columns"> | |||
| <div id="content"> | |||
| <h1 class="page-title">jQuery API</h1> | |||
| <p>jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. If you're new to jQuery, you might be interested in the <a href="http://learn.jquery.com/">jQuery Learning Center</a> tutorials.</p> | |||
|
|
|||
| <p>The API docs aren't specifically versioned, but you need to pay attention to the version info on each page.</p> | |||
There was a problem hiding this comment.
This is a very vague statement that doesn't provide any real value.
There was a problem hiding this comment.
The first time your visiting the api docs this makes sense IMHO. I'm going to update my PR later to include some other stuff discussed in jquery/api.jquery.com#44 too.
|
Updated my PR. |
|
Now this covers everything mentioned in the ticket. It's quite short so I think it just fits above the list of methods we have. @kswedberg @scottgonzalez @timmywil Would one of you be willing to do quick of a review? |
| @@ -2,6 +2,14 @@ | |||
| <div class="content-right listing twelve columns"> | |||
| <div id="content"> | |||
| <h1 class="page-title">jQuery API</h1> | |||
| <p>jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. If you're new to jQuery, we recommend to check out the <a href="http://learn.jquery.com/">jQuery Learning Center</a>.</p> | |||
There was a problem hiding this comment.
Change "we recommend to check out" to "we recommend that you check out"
|
Thanks @kswedberg! Addressed all your comments. |
| @@ -2,6 +2,14 @@ | |||
| <div class="content-right listing twelve columns"> | |||
| <div id="content"> | |||
| <h1 class="page-title">jQuery API</h1> | |||
| <p>jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. If you're new to jQuery, we recommend that you check out the <a href="http://learn.jquery.com/">jQuery Learning Center</a>.</p> | |||
| <p>If you're updating to a newer version of jQuery, be sure to read the release notes published on <a href="http://blog.jquery.com/">our blog</a>. If you're coming from a version prior 1.9, it's definitely worth it to check out the <a href="http://jquery.com/upgrade-guide/1.9/">1.9 Upgrade Guide</a> as well.</p> | |||
| <p>Note that this is the API documentation for jQuery core. Other projects have API docs on other locations:</p> | |||
|
Looks great @arthurvr ! Just a couple more minor tweaks as noted and then it's good to go, as far as I'm concerned. Thanks a lot for getting this done. |
|
@kswedberg Did the tweaks. Thanks! Gonna wait for some feedback from others as well. |
|
Looks good. |
|
👍 |
|
landing. |
|
woohoo! thanks again, @arthurvr ! |
This would fix jquery/api.jquery.com#44. It adds a little explanation about the API docs to the top of the index page. It's similar to the one on api.jqueryui.com, but even shorter.