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
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.
# | 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 | 53 | 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 |
70 (+3) | 2 | Missing pages:
|
22 | Promise | 8 | 1 | Complete. |
23 | Symbol | 9 | 2 |
Missing pages:
|
24 | ParallelArray | 1 | 5 | Complete. |
25 | Expressions & Operators | 29 | 1 | Complete. |
26 | Statements & Declarations | 27 | 1 | Complete. |
27 | Functions | 11 | 1 |
Complete. |
28 | Classes | 4 | 1 | WIP, Fx implementation in progress |
29 | JavaScript Guide | 15 | 1 |
|
30 | New in JavaScript | 15 | 4 |
Complete. |
31 | Articles/Tutorials/Misc | 17 |
3 |
|
32 | Meta pages | 9 | 4 |
Notes
New chapters to be written
# | Chapter | Pages | Priority | Notes |
---|---|---|---|---|
1 | Typed objects | 0 | 5 | In Nightly. https://github.com/dslomov-chromium/typed-objects-es7 |
2 | SharedArrayBuffer and Shared*Array types | 0 | 5 | In Nightly. |
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 (v8). 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 |
---|---|
{{SpecName('ES5.1')}} | {{Spec2('ES5.1')}} |
{{SpecName('ES6')}} | {{Spec2('ES6')}} |
{{SpecName('ES Int 1.0')}} | {{Spec2('ES Int 1.0')}} |
{{SpecName('ES Int 2.0')}} | {{Spec2('ES Int 2.0')}} |
{{TopicBox("JavaScript")}}