JavaScript documentation status

This page tries to track ongoing documentation work in the MDN JavaScript section. Feel free to contribute!

Summary

Pages	No tags	Needs* tags	Missing tags	Editorial reviews	Technical reviews	Outdated pages	Dev-doc-needed bugs	Documentation requests
626	2 (1%)	8 (2%)	2 (1%)	3 (1%)	10 (2%)	0 (0%)	18 (3%)	3 (1%)

See also localization status of this section.

No tags

Found 2 pages:

Needs* tags

Found 8 pages:

NeedsContent
- Numbers and dates
- Classes
NeedsBrowserCompatibility
- class
NeedsExample
NeedsUpdate
- export

Missing tags

At least missing one of the following: JavaScript

Found 2 pages:

Editorial reviews

Found 3 pages:

Technical reviews

Found 10 pages:

Dev-doc-needed bugs

Found 18 bugs:

Bug	Summary	Release
1066234	Support 'extends' in ES6 classes	mozilla39
1066233	Support ES6 ClassExpressions	mozilla39
1066238	Support 'static' MethodDefinitions in ES6 classes	mozilla39
1108949	RegExp(RegExp object, flags) no longer throws	mozilla39
1140428	Warn when __noSuchMethod__ is used	mozilla39
1031203	SIMD: Implement float64x2 in the interpreter	mozilla38
1110164	SIMD.js: Rename select into bitselect, implement select	mozilla37
1088709	SIMD: Add {float32x4,int32x4}.{load,store} to the interpreter	mozilla36
979594	Atomics and locks for SharedArrayBuffer: Plain JS	mozilla36
1054882	Make SharedArrayBuffer not a subtype of ArrayBuffer; fork TypedArray hierarchy	mozilla35
933001	Land SharedArrayBuffer Prototype Preffed-Off	mozilla30
946042	Add all SIMD functions to the interpreter using typed objects	mozilla29
922115	Support unsized arrays in typed objects	mozilla28
917454	[typed objs] Add objectType function	mozilla28
922172	Add redimension method for typed objects	mozilla28
938728	Implement basic support for float32x4 as a typed object constructor	mozilla28
914220	Move TypedObject names into a "TypedObject" quasi-module	mozilla27
898342	[binary data] add support for binary data handles	mozilla27

Browse as bug list.

Documentation requests

Found 3 bugs:

Bug	Summary
1073361	There ought to be a section explaining function signatures in JavaScript
1109166	Coherent docs for JS generators and iterators (ES6 and legacy)
1133271	JavaScript Guide overhaul

Browse as bug list.

Localizations

Please help us to localize this documentation into different languages.

Language	Pages	Translated	Translations up to date
bn-BD	626	28 (4%)	3 (0%)
ca	626	47 (7%)	42 (6%)
de	626	103 (16%)	42 (6%)
es	626	158 (25%)	28 (4%)
fa	626	5 (0%)	0 (0%)
fr	626	626 (100%)	624 (99%)
it	626	22 (3%)	3 (0%)
ja	626	331 (52%)	11 (1%)
ko	626	39 (6%)	3 (0%)
pl	626	229 (36%)	6 (0%)
pt-BR	626	95 (15%)	29 (4%)
ru	626	406 (64%)	313 (50%)
zh-CN	626	365 (58%)	77 (12%)

Cleanup and structure of the MDN JavaScript docs

All reference pages should have a consistent structure with information about browser compatibility, specification status, examples, introduction texts, proper tagging and formatting (content hierarchies, no links to redirects). Integrating the quicklinks navigation is also part of this update. Going through these pages can then help to identify gaps in our reference material and find pages in need of further updating for ES 5.1 and 6.

Chapters of the MDN JavaScript section and their status
#	Chapter	Pages	Priority	Notes
0	Value & function properties in the global scope	16	1	Complete.
1	Object	40	1	Complete. Missing pages for ES7: `Object.unobserve()`, `Object.getNotifier()`, `Object.deliverChangeRecords()`, ES7, in v8
2	Function	14	1	Complete.
3	Array	38	1	Complete. Missing pages for ES7: `Array.unobserve()`, ES7, in v8
4	String	50	1	Complete.
5	Boolean	5	1	Complete.
6	Number	24	1	Complete.
7	Math	44	1	Complete.
8	Date	53	1	Complete.
9	RegExp	21	1	ES6 TBD: new RegExp symbols bug 887016 @@species @@match @@replace @@search @@split
10	Error EvalError InternalError RangeError ReferenceError SyntaxError TypeError URIError	24	4	Complete.
11	JSON	3	1	Complete.
12	Intl Intl.Collator Intl.DateTimeFormat Intl.NumberFormat	16	2	Complete.
13	Map	13	2	Complete.
14	WeakMap	7	2	Complete.
15	Set	11	2	Complete.
16	WeakSet	6	2	Complete.
17	Proxy	17	3	Complete.
18	Reflect	1 (+14)	3	Sub pages missing (14 methods).
19	Generator (legacy and ES6) Iterator StopIteration GeneratorFunction	8	2	Complete.
20	`ArrayBuffer` (6) `DataView` (21) `TypedArray` (31 [+ 6]) `Float32Array` `Float64Array` `Int16Array` `Int32Array` `Int8Array` `Uint16Array` `Uint32Array` `Uint8Array` `Uint8ClampedArray`	67 (+6)	2	Missing pages: 6 standard Array methods not yet implemented for TypedArrays (tracking bug 1071668).
21	Promise	8	1	Complete.
22	Symbol	7	2	Missing pages: Well-known symbols Symbol.hasInstance Symbol.isConcatSpreadable Symbol.iterator Symbol.match Symbol.replace Symbol.search Symbol.species Symbol.split Symbol.toPrimitive Symbol.toStringTag Symbol.unscopables
23	ParallelArray	1	5	Complete.
24	Expressions & Operators	29	1	Missing pages: super class expression
25	Statements & Declarations	27	1	Needs ES6 update: export Missing pages: class declaration
26	Functions	11	1	Complete.
27	JavaScript Guide	15	1	WIP. Introduction Grammar and types Control flow and error handling Loops and iteration Functions Expressions and operators Numbers and dates Text formatting Indexed collections Keyed collections Working with objects Details of the object model Iterators and generators Meta programming Predefined Core Objects: Split into categories, see above. Regular Expressions: Merge with Text formatting, no need to make this so large with duplicated info from the reference
28	New in JavaScript	15	4	Complete.
29	Articles/Tutorials/Misc	17	3	Introductory: JavaScript technologies overview Introduction to Object-Oriented JavaScript Intermediate: A re-introduction to JavaScript (JS Tutorial) JavaScript data types and data structures Equality comparisons and sameness Closures Advanced: Inheritance and the prototype chain Strict mode Transitioning to strict mode JavaScript typed arrays Memory Management Misc reference: Enumerability and ownership of properties Iteration protocols Deprecated and obsolete features The legacy Iterator protocol Template Strings JavaScript shells Lexical grammar
30	Meta pages	9	4	Standard built-in objects JavaScript reference About this Reference JavaScript Language Resources Index About JavaScript JavaScript JavaScript methods index JavaScript properties index

Notes

New chapters to be written

#	Chapter	Priority	Notes
1	Classes	1	New in ES6. Needs new chapter. New chapter analog to Functions here: Classes. Outline: Introduction. JS is still prototype based yada yada. Defining classes (expressions & declarations) Class bodies and method definitions, special methods constructor and static methods Sub classes with `extends` Sub classing built-in objects Super class calls with `super` Example section Specification Browser compat See also Detail reference pages: class expression class declaration constructor method definition static method definition How to define other methods (that also work for object literals are here: Method definitions). To be linked from main class chapter page, but get,set, etc aren't new and not specific to classes. extends sub classing super
2	SIMD objects	3	In Nightly. https://github.com/johnmccutchan/ecmascript_simd
3	Typed objects	3	In Nightly. https://github.com/dslomov-chromium/typed-objects-es7

Other tasks to do

asm.js explanation doc ?
Go through Firefox release notes for developers and site compat notes and make sure JS changes are documented properly in the references.
Make sure our compat tables are up to date by also going trough bug trackers of other open source browsers (e.g. WebKit, Blink)
Write a changelog for Chrome JavaScript releases like we have for Firefox. Same for other browsers/node.js?
Meta article about how to document in the JS MDN area.
Create a page that explains error messages. So that people searching for errors will find guidance.

Tagging standard

For all pages at least the tag "JavaScript" should be added.
For methods belonging to an object it the name of the Object should be added (e.g. String.fromCharCode should have "String").
Methods should have "Method" and properties need a "Property" tag. All prototype methods have the "prototype" tag.
Features added in a new ECMAScript version have a "ECMAScript6" plus "Experimental".
Deprecated and obsolete features have the same named tags.
If pages need any type of work, a "Need*" tag should be added (see above).

Specifications

The following specifications are taken under consideration for this project:

Specification	Status
ECMAScript 5.1 (ECMA-262)	Standard
ECMAScript 6 (ECMA-262)	Release Candidate
ECMAScript Internationalization API 1.0 (ECMA-402)	Standard
ECMAScript Internationalization API 2.0 (ECMA-402)	Draft

Help the 'JavaScript' documentation project…

Topic driver : Florian Scholz (IRC nickname: fscholz)

Look at the current status of the 'JavaScript' documentation.

Don't hesitate to contact us on #mdn or on the dev-mdc mailing-list:

Mailing list