This page tries to track ongoing documentation work in the MDN JavaScript section. Feel free to contribute!
Summary
{{DocStatus('Web/JavaScript','[]', 'October 1, 2013', '[ { "keywords": ["dev-doc-needed"], "product": ["Core"], "component":["JavaScript Engine", "JavaScript: Standard Library", "JavaScript: Internationalization API"],"resolution":["FIXED", "INVALID", "WONTFIX", "DUPLICATE", "WORKSFORME", "INCOMPLETE", "SUPPORT", "MOVED", "EXPIRED"], "bug_status":["RESOLVED", "VERIFIED", "CLOSED"], "include_fields":["id", "target_milestone", "summary"], "order": "target_milestone desc", "whiteboard": "[DocArea=JS]" } ]','[ { "product": ["Developer Documentation"], "component":["JavaScript"],"resolution":["---"], "include_fields":["id", "summary"] } ]', '', '["JavaScript"]' )}}
Structure of the MDN JavaScript docs
# | Chapter | Pages | Priority | Notes |
---|---|---|---|---|
0 | Value & function properties in the global scope | 16 | 1 | Complete. |
1 | Object | 40 | 1 |
Complete. |
2 | Function | 14 | 1 | Complete. |
3 | Array | 38 | 1 | Complete. |
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 | Complete. |
10 |
Error |
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 | SIMD
Float32x4 |
3 | In Nightly. Spec in flux. | |
17 | WeakSet | 6 | 2 | Complete. |
18 | Proxy | 17 | 3 | Complete. |
19 | Reflect | 15 | 3 | Complete. |
20 | Generator (legacy and ES6) Iterator StopIteration GeneratorFunction |
8 | 2 | Complete. |
21 | ArrayBuffer (6)DataView (21)TypedArray (34 [+ 3])Float32Array Float64Array Int16Array Int32Array Int8Array Uint16Array Uint32Array Uint8Array Uint8ClampedArray |
73 | 2 | Missing pages:
|
22 | Promise | 8 | 1 | Complete. |
23 | Symbol | 9 | 2 |
Missing pages:
|
24 | ParallelArray | 1 | 5 | Complete. |
25 | Atomics SharedArrayBuffer |
17 | 4 | Preffed off. Spec in flux. |
26 | Expressions & Operators | 29 | 1 | Complete. |
27 | Statements & Declarations | 27 | 1 | Complete. |
28 | Functions | 11 | 1 |
Complete. |
29 | Classes | 4 | 1 | Complete. |
30 | JavaScript Guide | 15 | 1 |
|
31 | New in JavaScript | 15 | 4 |
Complete. |
32 | JavaScript error reference | 36 | 3 | Explains error messages (v8, Chakra). So that people searching for errors will find guidance. |
33 | Articles/Tutorials/Misc | 17 |
3 |
|
34 | Meta pages | 9 | 4 |
Other tasks to do
- 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.
Tagging standard
- Pages in the JavaScript/ page tree should at least have the tag "JavaScript".
- For methods belonging to an object, 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 members have the "prototype" tag.
- Features added in a new ECMAScript version have the tags "ECMAScript6" and "ECMAScript 2015" or later versions/years.
- The Experimental tag should only be used with new features where the standard in not yet finalized (e.g. in a strawman proposal) and the feature is in a Nightly version or behind a preference.
- Features are Deprecated if their usage is discouraged and are Obsolete if they have been removed from engines.
- If pages need any type of work, a "Needs*" tag should be added (see above).
Specifications
The following specifications are taken under consideration for this project:
Specification | Status |
---|---|
{{SpecName('ES5.1')}} | {{Spec2('ES5.1')}} |
{{SpecName('ES6')}} | {{Spec2('ES6')}} |
{{SpecName('ESDraft')}} | {{Spec2('ESDraft')}} |
{{SpecName('ES Int 1.0')}} | {{Spec2('ES Int 1.0')}} |
{{SpecName('ES Int 2.0')}} | {{Spec2('ES Int 2.0')}} |
{{SpecName('ES Int Draft')}} | {{Spec2('ES Int Draft')}} |
{{SpecName('SIMD')}} | {{Spec2('SIMD')}} |
{{SpecName('Shared Memory')}} | {{Spec2('Shared Memory')}} |
Proposals (with advanced stage and at least 1 implementation) | Draft |
{{TopicBox("JavaScript")}}