Comments (12)
Scott and I disagree on this. I've always liked that api.jquery.com goes straight to docs. Skip the useless intro. I don't think we need to say which version the docs apply to. They apply to the current version. If it's behind, it's a bug. We update docs before releases. All versions are listed on the page in the sidenav. And it seems to me the learn site (and therefore its tutorials) can stay separate.
from api.jquery.com.
I don't think the intro is "useless" -- clearly there are a few things that need to be commonly pointed out to consumers of the API docs, and there are ultimately plans for versioned docs, because it's a pain point we hear about often. A major reason the learn site and try.jquery.com exist is because people come to the API docs expecting to "learn how to use jQuery" but it really isn't that at all....it's just a listing of methods... we should point those people to the right place and explain that they aren't there yet. Not sure why we would want to keep those things "separate."
On the other hand, there is something really convenient about having the full method listing available for quick Cmd-F'ing and finding the method you're looking for docs on. A lot of other open source js libs do this by having the full method listing as navigation on the left hand side (instead we have categories, which are of dubious utility IMHO). Indeed, we could probably keep the full method listing on the home page and just put the basic "who what and where" information above it, similar to Underscore.js.
Best of both worlds?
from api.jquery.com.
+1 to having a brief intro above the listing on the homepage. What do y'all think about #227 and #228?
from api.jquery.com.
Ok, maybe I was just thinking about how I use the docs site. But I think Adam's solution is great.
from api.jquery.com.
Also, @kswedberg, I completely agree restoring those conveniences would be great. If I could get the time, I'd submit a pull myself.
from api.jquery.com.
woops tricky mouses.
from api.jquery.com.
What is the action on this? Just a short summary at the top of our current home page? Given that this is the API reference I don't think we need links to tutorials or or other topics like plugins.
from api.jquery.com.
I think something similar to http://api.jqueryui.com/ would be good.
Some things that would be useful:
- Links to the changelogs and upgrade guides.
- Links for beginners that point to learn.jquery.com and try.jquery.com.
- Links to other API sites (UI, Mobile, but just the home pages, not a list of each versioned site).
There's clearly still debate about whether there should be a massive dump on the home page. I still think linking to a separate page (http://api.jquery.com/category/all/) is better (BTW, we need to figure out why that page is broken now - it's broken on all of our API sites).
from api.jquery.com.
I created jquery/jquery-wp-content#278 to track the /category/all problem.
from api.jquery.com.
I just created a PR adding a brief note to the homepage: jquery/jquery-wp-content#333.
from api.jquery.com.
I was recently working on finalizing my PR for this. It definitely needs some updates.
Links to the changelogs and upgrade guides.
@scottgonzalez Is there some page with an overview of all release notes? I can't seem to find a page covering them all.
from api.jquery.com.
As far as I know, the core team has never done any changelogs or upgrade guides outside of blog posts, other than http://jquery.com/upgrade-guide/1.9/. So the only way to find them is to search through the blog history.
from api.jquery.com.
Related Issues (20)
- scrollLeft() does not always return an Integer
- Contradiction about outerWidth on window between API documentation and migration guide
- Document jQuery.fx.interval removal from jQuery 4.0.0
- typo in demo answers HOT 1
- Document deprecation of event shorthands like jQuery.fn.click() HOT 1
- $.ajax() documentation should be fixed in a case where script isn't necessarily executed yet HOT 13
- :contains()'s page should have the "… is a jQuery extension" note
- Please improve documentation: ajaxComplete is called before or after success/error callbacks? HOT 2
- Document binary data support for 4.0
- Document jQuery.Deferred.getErrorHook & jQuery.Deferred.getStackHook
- Usability Error - Links HOT 2
- Add Sizzle wiki as API page HOT 3
- Typo in .removeAttr() example HOT 6
- Typo in .animate() reference documentation HOT 2
- Documentation for ajax does not mention FormData HOT 4
- Add GitHub action workflow for running lint on commit
- position offset HOT 2
- Mention of ‘timestamp’ in documentation for ‘cache’ parameter of ‘ajax’ is misleading HOT 2
- Document changes in boolean attributes treatment HOT 1
- Documentation error for text() HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api.jquery.com.