Split README into files located at /docs

CONTRIBUTING.md

@@ -66,40 +66,40 @@ File names should be in the kebab-case. Name of polyfill modules should follow t
 ## Testing
 
 Before testing, you should install dependencies:
-```
+```sh
 $ npm i
 ```
 You can run all tests by
-```
+```sh
 $ npm run test
 ```
 You can run parts of the test case separately:
 - Linting:
-  ```
+  ```sh
   $ npm run lint
   ```
 - The global version unit tests:
-  ```
+  ```sh
   $ npm run test-unit-global-standalone
   ```
 - The pure version unit tests:
-  ```
+  ```sh
   $ npm run test-unit-pure-standalone
   ```
 - [Promises/A+](https://github.com/promises-aplus/promises-tests) and [ES6 `Promise`](https://github.com/promises-es6/promises-es6) test cases:
-  ```
+  ```sh
   $ npm run test-promises-standalone
   ```
 - [ECMAScript `Observable` test case](https://github.com/tc39/proposal-observable):
-  ```
+  ```sh
   $ npm run test-observables-standalone
   ```
 - CommonJS entry points tests:
-  ```
+  ```sh
   $ npm run test-entries-standalone
   ```
 - If you want to run tests in a certain browser, at first, you should build packages and test bundles:
-  ```
+  ```sh
   $ npm run bundle-standalone
   ```
 - For running the global version of the unit test case, use this file:

deno/corejs/README.md

@@ -2,11 +2,11 @@
 
 [![Open Collective](https://opencollective.com/core-js/all/badge.svg?label=open%20collective)](https://opencollective.com/core-js) [![version](https://img.shields.io/npm/v/core-js.svg)](https://www.npmjs.com/package/core-js) [![core-js downloads](https://img.shields.io/npm/dm/core-js.svg?label=npm%20i%20core-js)](https://npm-stat.com/charts.html?package=core-js&package=core-js-pure&package=core-js-compat&from=2014-11-18) [![core-js-pure downloads](https://img.shields.io/npm/dm/core-js-pure.svg?label=npm%20i%20core-js-pure)](https://npm-stat.com/charts.html?package=core-js&package=core-js-pure&package=core-js-compat&from=2014-11-18) [![tests](https://github.com/zloirock/core-js/workflows/tests/badge.svg)](https://github.com/zloirock/core-js/actions) [![eslint](https://github.com/zloirock/core-js/workflows/eslint/badge.svg)](https://github.com/zloirock/core-js/actions)
 
-> Modular standard library for JavaScript. Includes polyfills for [ECMAScript up to 2021](https://github.com/zloirock/core-js#ecmascript): [promises](https://github.com/zloirock/core-js#ecmascript-promise), [symbols](https://github.com/zloirock/core-js#ecmascript-symbol), [collections](https://github.com/zloirock/core-js#ecmascript-collections), iterators, [typed arrays](https://github.com/zloirock/core-js#ecmascript-typed-arrays), many other features, [ECMAScript proposals](https://github.com/zloirock/core-js#ecmascript-proposals), [some cross-platform WHATWG / W3C features and proposals](#web-standards) like [`URL`](https://github.com/zloirock/core-js#url-and-urlsearchparams). You can load only required features or use it without global namespace pollution.
+> Modular standard library for JavaScript. Includes polyfills for [ECMAScript up to 2021](/README.md#ecmascript): [promises](/README.md#ecmascript-promise), [symbols](/README.md#ecmascript-symbol), [collections](/README.md#ecmascript-collections), iterators, [typed arrays](/README.md#ecmascript-typed-arrays), many other features, [ECMAScript proposals](/README.md#ecmascript-proposals), [some cross-platform WHATWG / W3C features and proposals](/README.md#web-standards) like [`URL`](/README.md#url-and-urlsearchparams). You can load only required features or use it without global namespace pollution.
 
 ## As advertising: the author is looking for a good job -)
 
-## [core-js@3, babel and a look into the future](https://github.com/zloirock/core-js/tree/master/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md)
+## [core-js@3, babel and a look into the future](/docs/2019-03-19-core-js-3-babel-and-a-look-into-the-future.md)
 
 ## Raising funds
 
@@ -46,4 +46,4 @@ Promise.any([
   .toArray();                          // => [9, 25]
 ```
 
-**It's a bundled global version for Deno 1.0+, for more info see [`core-js` documentation](https://github.com/zloirock/core-js/blob/master/README.md).**
+**It's a bundled global version for Deno 1.0+, for more info see [`core-js` documentation](/README.md).**

docs/compatibility-data.md

@@ -0,0 +1,21 @@
+# Compat data
+`core-js` project provides (as [`core-js-compat`](/packages/core-js-compat) package) all required data about the necessity of `core-js` modules, entry points, and tools for work with it - it's useful for integration with tools like `babel` or `swc`. If you wanna help, you could take a look at the related section of [`CONTRIBUTING.md`](/CONTRIBUTING.md#how-to-update-core-js-compat-data). The visualization of compatibility data and the browser tests runner is available [here](http://zloirock.github.io/core-js/compat/), the example:
+
+![compat-table](https://user-images.githubusercontent.com/2213682/180694428-856bcd0f-cab3-446f-be1a-2f669614dcc0.png)
+
+# Supported engines
+**Tested in:**
+- Chrome 26+
+- Firefox 4+
+- Safari 5+
+- Opera 12+
+- Internet Explorer 8+ (sure, IE8 with ES3 limitations; IE7- also should work, but no longer tested)
+- Edge
+- Android Browser 2.3+
+- iOS Safari 5.1+
+- PhantomJS 1.9+
+- NodeJS 0.8+
+- Deno 1.0+
+- Rhino 1.7.14+
+
+...and it doesn't mean `core-js` will not work in other engines, they just have not been tested.

docs/features/README.md

@@ -0,0 +1,10 @@
+# Features
+These are divided in 3 main categories:
+- [ES](ecmascript/README.md)
+- [Proposals](proposals/README.md)
+- [Web standards](web-standards/README.md)
+
+[*CommonJS entry points:*](docs/usage.md#commonjs-api)
+```
+core-js(-pure)
+```

docs/features/ecmascript/README.md

@@ -0,0 +1,24 @@
+# ES
+Polyfills for properties of global object namespaces.
+
+[*CommonJS entry points:*](docs/usage.md#commonjs-api)
+```
+core-js(-pure)/es
+```
+
+## Index
+- [`Object`](object.md)
+- [`Function`](function.md)
+- [`Error`](error.md)
+- [`Array`](array.md)
+- [`String` and `RegExp`](string%20and%20regexp.md)
+- [`Number`](number.md)
+- [`Math`](math.md)
+- [`Date`](date.md)
+- [`Promise`](promise.md)
+- [`Symbol`](symbol.md)
+- [Collections](collections.md)
+- [`TypedArray`s](typed-array.md)
+- [`Reflect`](reflect.md)
+- [`JSON`](json.md)
+- [`globalThis`](global-this.md)

docs/features/ecmascript/array.md

@@ -0,0 +1,165 @@
+# `Array`
+Modules [`es.array.from`](/packages/core-js/modules/es.array.from.js), [`es.array.is-array`](/packages/core-js/modules/es.array.is-array.js), [`es.array.of`](/packages/core-js/modules/es.array.of.js), [`es.array.copy-within`](/packages/core-js/modules/es.array.copy-within.js), [`es.array.fill`](/packages/core-js/modules/es.array.fill.js), [`es.array.find`](/packages/core-js/modules/es.array.find.js), [`es.array.find-index`](/packages/core-js/modules/es.array.find-index.js), [`es.array.find-last`](/packages/core-js/modules/es.array.find-last.js), [`es.array.find-last-index`](/packages/core-js/modules/es.array.find-last-index.js), [`es.array.iterator`](/packages/core-js/modules/es.array.iterator.js), [`es.array.includes`](/packages/core-js/modules/es.array.includes.js), [`es.array.push`](/packages/core-js/modules/es.array.push.js), [`es.array.slice`](/packages/core-js/modules/es.array.slice.js), [`es.array.join`](/packages/core-js/modules/es.array.join.js), [`es.array.unshift`](/packages/core-js/modules/es.array.unshift.js), [`es.array.index-of`](/packages/core-js/modules/es.array.index-of.js), [`es.array.last-index-of`](/packages/core-js/modules/es.array.last-index-of.js), [`es.array.every`](/packages/core-js/modules/es.array.every.js), [`es.array.some`](/packages/core-js/modules/es.array.some.js), [`es.array.for-each`](/packages/core-js/modules/es.array.for-each.js), [`es.array.map`](/packages/core-js/modules/es.array.map.js), [`es.array.filter`](/packages/core-js/modules/es.array.filter.js), [`es.array.reduce`](/packages/core-js/modules/es.array.reduce.js), [`es.array.reduce-right`](/packages/core-js/modules/es.array.reduce-right.js), [`es.array.reverse`](/packages/core-js/modules/es.array.reverse.js), [`es.array.sort`](/packages/core-js/modules/es.array.sort.js), [`es.array.flat`](/packages/core-js/modules/es.array.flat.js), [`es.array.flat-map`](/packages/core-js/modules/es.array.flat-map.js), [`es.array.unscopables.flat`](/packages/core-js/modules/es.array.unscopables.flat.js), [`es.array.unscopables.flat-map`](/packages/core-js/modules/es.array.unscopables.flat-map.js), [`es.array.at`](/packages/core-js/modules/es.array.at.js).
+```ts
+class Array {
+  at(index: int): any;
+  concat(...args: Array<mixed>): Array<mixed>; // with adding support of @@isConcatSpreadable and @@species
+  copyWithin(target: number, start: number, end?: number): this;
+  entries(): Iterator<[index, value]>;
+  every(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): boolean;
+  fill(value: any, start?: number, end?: number): this;
+  filter(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): Array<mixed>; // with adding support of @@species
+  find(callbackfn: (value: any, index: number, target: any) => boolean), thisArg?: any): any;
+  findIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint;
+  findLast(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): any;
+  findLastIndex(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): uint;
+  flat(depthArg?: number = 1): Array<mixed>;
+  flatMap(mapFn: (value: any, index: number, target: any) => any, thisArg: any): Array<mixed>;
+  forEach(callbackfn: (value: any, index: number, target: any) => void, thisArg?: any): void;
+  includes(searchElement: any, from?: number): boolean;
+  indexOf(searchElement: any, from?: number): number;
+  join(separator: string = ','): string;
+  keys(): Iterator<index>;
+  lastIndexOf(searchElement: any, from?: number): number;
+  map(mapFn: (value: any, index: number, target: any) => any, thisArg?: any): Array<mixed>; // with adding support of @@species
+  push(...args: Array<mixed>): uint;
+  reduce(callbackfn: (memo: any, value: any, index: number, target: any) => any, initialValue?: any): any;
+  reduceRight(callbackfn: (memo: any, value: any, index: number, target: any) => any, initialValue?: any): any;
+  reverse(): this; // Safari 12.0 bug fix
+  slice(start?: number, end?: number): Array<mixed>; // with adding support of @@species
+  splice(start?: number, deleteCount?: number, ...items: Array<mixed>): Array<mixed>; // with adding support of @@species
+  some(callbackfn: (value: any, index: number, target: any) => boolean, thisArg?: any): boolean;
+  sort(comparefn?: (a: any, b: any) => number): this; // with modern behavior like stable sort
+  unshift(...args: Array<mixed>): uint;
+  values(): Iterator<value>;
+  @@iterator(): Iterator<value>;
+  @@unscopables: { [newMethodNames: string]: true };
+  static from(items: Iterable | ArrayLike, mapFn?: (value: any, index: number) => any, thisArg?: any): Array<mixed>;
+  static isArray(value: any): boolean;
+  static of(...args: Array<mixed>): Array<mixed>;
+}
+
+class Arguments {
+  @@iterator(): Iterator<value>; // available only in core-js methods
+}
+```
+[*CommonJS entry points:*](/docs/usage.md#commonjs-api)
+```
+core-js(-pure)/es|stable|actual|full/array
+core-js(-pure)/es|stable|actual|full/array/from
+core-js(-pure)/es|stable|actual|full/array/of
+core-js(-pure)/es|stable|actual|full/array/is-array
+core-js(-pure)/es|stable|actual|full/array/at
+core-js(-pure)/es|stable|actual|full/array/concat
+core-js(-pure)/es|stable|actual|full/array/entries
+core-js(-pure)/es|stable|actual|full/array/every
+core-js(-pure)/es|stable|actual|full/array/copy-within
+core-js(-pure)/es|stable|actual|full/array/fill
+core-js(-pure)/es|stable|actual|full/array/filter
+core-js(-pure)/es|stable|actual|full/array/find
+core-js(-pure)/es|stable|actual|full/array/find-index
+core-js(-pure)/es|stable|actual|full/array/find-last
+core-js(-pure)/es|stable|actual|full/array/find-last-index
+core-js(-pure)/es|stable|actual|full/array/flat
+core-js(-pure)/es|stable|actual|full/array/flat-map
+core-js(-pure)/es|stable|actual|full/array/for-each
+core-js(-pure)/es|stable|actual|full/array/includes
+core-js(-pure)/es|stable|actual|full/array/index-of
+core-js(-pure)/es|stable|actual|full/array/iterator
+core-js(-pure)/es|stable|actual|full/array/join
+core-js(-pure)/es|stable|actual|full/array/keys
+core-js(-pure)/es|stable|actual|full/array/last-index-of
+core-js(-pure)/es|stable|actual|full/array/map
+core-js(-pure)/es|stable|actual|full/array/push
+core-js(-pure)/es|stable|actual|full/array/reduce
+core-js(-pure)/es|stable|actual|full/array/reduce-right
+core-js(-pure)/es|stable|actual|full/array/reverse
+core-js(-pure)/es|stable|actual|full/array/slice
+core-js(-pure)/es|stable|actual|full/array/splice
+core-js(-pure)/es|stable|actual|full/array/some
+core-js(-pure)/es|stable|actual|full/array/sort
+core-js(-pure)/es|stable|actual|full/array/unshift
+core-js(-pure)/es|stable|actual|full/array/values
+core-js(-pure)/es|stable|actual|full/array/virtual/at
+core-js(-pure)/es|stable|actual|full/array/virtual/concat
+core-js(-pure)/es|stable|actual|full/array/virtual/copy-within
+core-js(-pure)/es|stable|actual|full/array/virtual/entries
+core-js(-pure)/es|stable|actual|full/array/virtual/every
+core-js(-pure)/es|stable|actual|full/array/virtual/fill
+core-js(-pure)/es|stable|actual|full/array/virtual/filter
+core-js(-pure)/es|stable|actual|full/array/virtual/find
+core-js(-pure)/es|stable|actual|full/array/virtual/find-index
+core-js(-pure)/es|stable|actual|full/array/virtual/find-last
+core-js(-pure)/es|stable|actual|full/array/virtual/find-last-index
+core-js(-pure)/es|stable|actual|full/array/virtual/flat
+core-js(-pure)/es|stable|actual|full/array/virtual/flat-map
+core-js(-pure)/es|stable|actual|full/array/virtual/for-each
+core-js(-pure)/es|stable|actual|full/array/virtual/includes
+core-js(-pure)/es|stable|actual|full/array/virtual/index-of
+core-js(-pure)/es|stable|actual|full/array/virtual/iterator
+core-js(-pure)/es|stable|actual|full/array/virtual/join
+core-js(-pure)/es|stable|actual|full/array/virtual/keys
+core-js(-pure)/es|stable|actual|full/array/virtual/last-index-of
+core-js(-pure)/es|stable|actual|full/array/virtual/map
+core-js(-pure)/es|stable|actual|full/array/virtual/push
+core-js(-pure)/es|stable|actual|full/array/virtual/reduce
+core-js(-pure)/es|stable|actual|full/array/virtual/reduce-right
+core-js(-pure)/es|stable|actual|full/array/virtual/reverse
+core-js(-pure)/es|stable|actual|full/array/virtual/slice
+core-js(-pure)/es|stable|actual|full/array/virtual/some
+core-js(-pure)/es|stable|actual|full/array/virtual/sort
+core-js(-pure)/es|stable|actual|full/array/virtual/splice
+core-js(-pure)/es|stable|actual|full/array/virtual/unshift
+core-js(-pure)/es|stable|actual|full/array/virtual/values
+```
+[*Examples*](https://tinyurl.com/2br28bgj):
+```js
+Array.from(new Set([1, 2, 3, 2, 1]));        // => [1, 2, 3]
+Array.from({ 0: 1, 1: 2, 2: 3, length: 3 }); // => [1, 2, 3]
+Array.from('123', Number);                   // => [1, 2, 3]
+Array.from('123', it => it * it);            // => [1, 4, 9]
+
+Array.of(1);       // => [1]
+Array.of(1, 2, 3); // => [1, 2, 3]
+
+let array = ['a', 'b', 'c'];
+
+for (let value of array) console.log(value);          // => 'a', 'b', 'c'
+for (let value of array.values()) console.log(value); // => 'a', 'b', 'c'
+for (let key of array.keys()) console.log(key);       // => 0, 1, 2
+for (let [key, value] of array.entries()) {
+  console.log(key);                                   // => 0, 1, 2
+  console.log(value);                                 // => 'a', 'b', 'c'
+}
+
+function isOdd(value) {
+  return value % 2;
+}
+[4, 8, 15, 16, 23, 42].find(isOdd);      // => 15
+[4, 8, 15, 16, 23, 42].findIndex(isOdd); // => 2
+[1, 2, 3, 4].findLast(isOdd);            // => 3
+[1, 2, 3, 4].findLastIndex(isOdd);       // => 2
+
+Array(5).fill(42); // => [42, 42, 42, 42, 42]
+
+[1, 2, 3, 4, 5].copyWithin(0, 3); // => [4, 5, 3, 4, 5]
+
+
+[1, 2, 3].includes(2);        // => true
+[1, 2, 3].includes(4);        // => false
+[1, 2, 3].includes(2, 2);     // => false
+
+[NaN].indexOf(NaN);           // => -1
+[NaN].includes(NaN);          // => true
+Array(1).indexOf(undefined);  // => -1
+Array(1).includes(undefined); // => true
+
+[1, [2, 3], [4, 5]].flat();    // => [1, 2, 3, 4, 5]
+[1, [2, [3, [4]]], 5].flat();  // => [1, 2, [3, [4]], 5]
+[1, [2, [3, [4]]], 5].flat(3); // => [1, 2, 3, 4, 5]
+
+[{ a: 1, b: 2 }, { a: 3, b: 4 }, { a: 5, b: 6 }].flatMap(it => [it.a, it.b]); // => [1, 2, 3, 4, 5, 6]
+
+[1, 2, 3].at(1);  // => 2
+[1, 2, 3].at(-1); // => 3
+```