Closed Bug 1476207 Opened 6 years ago Closed 4 years ago

I've written a cheat sheet for Javascript with active links toMDN pages

Categories

(Developer Documentation Graveyard :: JavaScript, enhancement, P5)

All
Other
enhancement

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: author, Assigned: cmills)

Details

(Whiteboard: [specification][type:feature])

What problem would this feature solve?
======================================
Is it .slice() or .splice()?  For anyone accessing the API they need a quick-reference.   This might mean 
(1) instant 'ah yes - that's the method I want' just from the name.
(2) Of course!  It returns -1 not undefined, from the headline, or
(3) let's check the details by going to the method page.

With an up-to-date quick reference, programmers can access the full scope of Javascript features.   Without it they may be relying on partial or obsolete hard-coded references or even memory.

Who has this problem?
=====================
All visitors to MDN

How do you know that the users identified above have this problem?
==================================================================
I use it every day.

How are the users identified above solving this problem now?
============================================================
The hard way.  Or not using the full scope of Javascript.


Do you have any suggestions for solving the problem? Please explain in detail.
==============================================================================
I've written just such a thing, which is a simple automated scrape of existing API pages.  It's available at vulpeculox.net/misc/jsjq/jsCheat/index.htm in a standalone, downloadable or instantly usable form.

Perhaps this useful tool would be re-skinned and re-homed for the MDN pages.

* Complete with the scraping code.
* Caches the result in localStorage after first scrape.  (ie If it detects no local pretty HTML ready to show it will create it.)
* Tool-tip (actually just TITLE attribute) is the headline
* Button link goes straight to API method/property page on MDN
* Array,String,Date,Math,Object,Number,Promise,RegExp



Is there anything else we should know?
======================================
Please drop me a line if you're *NOT* interested. 
It's all free of course.
Component: API → JavaScript
Product: developer.mozilla.org → Developer Documentation
This is worth linking to, but we don't really have resources to put into it right now to do much more.
Assignee: nobody → cmills
Priority: -- → P5
MDN Web Docs' bug reporting has now moved to GitHub. From now on, please file content bugs at https://github.com/mdn/sprints/issues/ and platform bugs at https://github.com/mdn/kuma/issues/.
Status: UNCONFIRMED → RESOLVED
Closed: 4 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.