From 71faf8ed719406b1cb29594cfd22c7e362195d11 Mon Sep 17 00:00:00 2001 From: Onkar Ruikar <87750369+OnkarRuikar@users.noreply.github.com> Date: Tue, 12 Dec 2023 20:12:04 +0530 Subject: [PATCH] fix: links in markdown documentation (#21543) * fix: links in markdown documentation * remove leading `./` from links to make them uniform * use relative URLs `./` everywhere --- CODE_OF_CONDUCT.md | 2 +- GOVERNANCE.md | 6 +++--- README.md | 26 ++++++++++++------------- docs/contributing.md | 14 ++++++------- docs/data-guidelines/index.md | 2 +- docs/faq.md | 2 +- docs/matching-browser-releases/index.md | 16 +++++++-------- docs/publishing.md | 2 +- release_notes/v0.md | 2 +- release_notes/v1.md | 6 +++--- release_notes/v2.md | 2 +- release_notes/v3.md | 8 ++++---- schemas/compat-data-schema.md | 6 +++--- 13 files changed, 47 insertions(+), 47 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 137fa8a89c313e..3cec834393d83d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -10,4 +10,4 @@ For more information on how to report violations of the Community Participation ## Project Specific Etiquette -For more specific information about how and by whom this project is governed, please see the BCD [governance](GOVERNANCE.md) doc. +For more specific information about how and by whom this project is governed, please see the BCD [governance](./GOVERNANCE.md) doc. diff --git a/GOVERNANCE.md b/GOVERNANCE.md index eb78fab71738be..7f91190aef7309 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -6,11 +6,11 @@ ### Community members -_Everyone_ who is involved in any form with the project must abide by the project’s [Contribution Guidelines](CODE_OF_CONDUCT.md) and Commit Access Guidelines. Everyone is expected to be respectful of fellow community members and to work collaboratively respective of the Code of Conduct (CPG). Consequences for not adhering to these Guidelines are listed in their respective documents. +_Everyone_ who is involved in any form with the project must abide by the project’s [Contribution Guidelines](./CODE_OF_CONDUCT.md) and Commit Access Guidelines. Everyone is expected to be respectful of fellow community members and to work collaboratively respective of the Code of Conduct (CPG). Consequences for not adhering to these Guidelines are listed in their respective documents. ### Users -Users are community members who have a need for the project. They are typically consumers of the compat data (see [data consumers](README.md#projects-using-the-data)). Anyone can be a User; there are no special requirements and the data is licensed under [CC0](LICENSE). Common User contributions include evangelizing the project (e.g., display a link on a website and raise awareness through word-of-mouth), informing developers of strengths and weaknesses from a new user perspective, or providing moral support (a “thank you” goes a long way). +Users are community members who have a need for the project. They are typically consumers of the compat data (see [data consumers](./README.md#projects-using-the-data)). Anyone can be a User; there are no special requirements and the data is licensed under [CC0](./LICENSE). Common User contributions include evangelizing the project (e.g., display a link on a website and raise awareness through word-of-mouth), informing developers of strengths and weaknesses from a new user perspective, or providing moral support (a “thank you” goes a long way). Users who continue to engage with the project and its community will often become more and more involved. Such Users may find themselves becoming [Contributors](#Contributors), as described in the next section. @@ -132,7 +132,7 @@ If an agenda item cannot reach a consensus, an owner can call for either a closi ## Licensing Please note that this project is made available using the -[CC0 license](LICENSE), +[CC0 license](./LICENSE), so anyone contributing should only submit data if they know they have the right to submit it under CC0. If you're not sure about that, just ask. ## Project Meetings diff --git a/README.md b/README.md index 73d321a71642b2..a58e2c18b8d91c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ The `browser-compat-data` ("BCD") project contains machine-readable browser (and JavaScript runtime) compatibility data for Web technologies, such as Web APIs, JavaScript features, CSS properties and more. Our goal is to document accurate compatibility data for Web technologies, so web developers may write cross-browser compatible websites easier. BCD is used in web apps and software such as [MDN Web Docs](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs), CanIUse, Visual Studio Code, WebStorm and [more](#Projects-using-the-data). -Read how this project is [governed](GOVERNANCE.md). +Read how this project is [governed](./GOVERNANCE.md). Chat with us on Matrix at [chat.mozilla.org#mdn](https://chat.mozilla.org/#/room/#mdn:mozilla.org)! @@ -83,7 +83,7 @@ const support = bcd['api']['Document']['body']['__compat']; The `@mdn/browser-compat-data` package contains a tree of objects, with support and browser data objects at their leaves. There are over 15,000 features in the dataset; this documentation highlights significant portions, but many others exist at various levels of the tree. -The definitive description of the format used to represent individual features and browsers is the [schema definitions](schemas/). +The definitive description of the format used to represent individual features and browsers is the [schema definitions](./schemas/). Apart from the explicitly documented objects below, feature-level support data may change at any time. See [_Semantic versioning policy_](#Semantic-versioning-policy) for details. @@ -96,15 +96,15 @@ An object containing the following package metadata: - `version` - the package version - `timestamp` - the timestamp of when the package version was built -### [`api`](api) +### [`api`](./api) Data for [Web API](https://developer.mozilla.org/en-US/docs/Web/API) features. -### [`browsers`](browsers) +### [`browsers`](./browsers) -Data for browsers and JavaScript runtimes. See the [browser schema](schemas/browsers-schema.md) for details. +Data for browsers and JavaScript runtimes. See the [browser schema](./schemas/browsers-schema.md) for details. -### [`css`](css) +### [`css`](./css) Data for [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS) features, including: @@ -129,7 +129,7 @@ Data for [HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP) features, inc - `methods` - Request methods - `status` - Status codes -### [`javascript`](javascript) +### [`javascript`](./javascript) Data for JavaScript language features, including: @@ -140,28 +140,28 @@ Data for JavaScript language features, including: - `operators` - Mathematical and logical operators - `statements` - Language statements and expressions -### [`mathml`](mathml) +### [`mathml`](./mathml) Data for [MathML](https://developer.mozilla.org/en-US/docs/Web/MathML) features, including: - `elements` - Elements -### [`svg`](svg) +### [`svg`](./svg) Data for [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) features, including: - `attributes` - Attributes - `elements` - Elements -### [`webassembly`](webassembly) +### [`webassembly`](./webassembly) Data for [WebAssembly](https://developer.mozilla.org/docs/WebAssembly) features. -### [`webdriver`](webdriver) +### [`webdriver`](./webdriver) Data for [WebDriver](https://developer.mozilla.org/en-US/docs/Web/WebDriver) features. -### [`webextensions`](webextensions) +### [`webextensions`](./webextensions) Data for [WebExtensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions) features, including: @@ -186,7 +186,7 @@ If you find a problem with the compatibility data (such as incorrect version num ## Contributing -Thank you for your interest in contributing to this project! See [Contributing to browser-compat-data](/docs/contributing.md) for more information. +Thank you for your interest in contributing to this project! See [Contributing to browser-compat-data](./docs/contributing.md) for more information. ## Projects using the data diff --git a/docs/contributing.md b/docs/contributing.md index 795a0b565e5229..77b149fe928746 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -22,11 +22,11 @@ The BCD project welcomes contributors of all kinds, however there are a few requ ### Guidelines -The project requires that all contributors follow [Mozilla's code of conduct and etiquette guidelines](/CODE_OF_CONDUCT.md). Violations of these guidelines may result in exclusion from all MDN Web Docs projects. +The project requires that all contributors follow [Mozilla's code of conduct and etiquette guidelines](./CODE_OF_CONDUCT.md). Violations of these guidelines may result in exclusion from all MDN Web Docs projects. -This project has [a formal governance document](/GOVERNANCE.md), which describes how various types of contributors work within the project and how decisions are made. +This project has [a formal governance document](./GOVERNANCE.md), which describes how various types of contributors work within the project and how decisions are made. -The repository is licensed under the [Creative Commons CC0 Public Domain Dedication](/LICENSE) license. Any contributions must be compatible with its terms. If you are contributing for a company or other organization, please ask your employer. +The repository is licensed under the [Creative Commons CC0 Public Domain Dedication](./LICENSE) license. Any contributions must be compatible with its terms. If you are contributing for a company or other organization, please ask your employer. ### Prerequisites @@ -86,7 +86,7 @@ These resources are helpful for updating Chromium-based browsers, including Chro - [Safari Release Notes](https://developer.apple.com/documentation/safari-release-notes): A list of release notes for different versions of Safari. - [WebKit Bugzilla](https://bugs.webkit.org/): The bug tracker for Safari/WebKit. - [WebKit Repo](https://github.com/WebKit/WebKit): The source code repository for WebKit, the engine for Safari. Useful to find specific behavior changes that are hard to test in the browser. -- [Backported Releases List](issue-triage-checklist.md#backported-releases): A list of Safari releases that were backports of newer versions and should be ignored. +- [Backported Releases List](./data-guidelines/index.md#backported-releases): A list of Safari releases that were backports of newer versions and should be ignored. #### Edge @@ -99,7 +99,7 @@ There are many ways you can help improve this repository! For example: - **Fix a bug:** we have a list of [issues](https://github.com/mdn/browser-compat-data/issues), or maybe you found your own. We recommend checking out issues labeled as ["good first issue"](https://github.com/mdn/browser-compat-data/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue+%3A100%3A%22) or ["help wanted"](https://github.com/mdn/browser-compat-data/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted+%3Asos%3A%22) first. - **Fix existing compat data**: maybe a browser now supports a certain feature. Yay! If you open a PR to fix a browser's data, it would be most helpful if you include a link to a bug report or similar so that we can double-check the good news. -- **Add new compat data**: familiarize yourself with the [compat data schema](../schemas/compat-data-schema.md) and [data guidelines](data-guidelines/index.md) to add new features. +- **Add new compat data**: familiarize yourself with the [compat data schema](../schemas/compat-data-schema.md) and [data guidelines](./data-guidelines/index.md) to add new features. - **Review a pull request:** there is a list of [PRs](https://github.com/mdn/browser-compat-data/pulls). Let us know if these look good to you. ### Updating the compat data @@ -112,7 +112,7 @@ When adding data for a particular feature, you'll often need to find which versi ## Opening pull requests -Before submitting your pull request, [validate your new data against the schema](testing.md). +Before submitting your pull request, [validate your new data against the schema](./testing.md). Not everything is enforced or validated by the schema. A few things to pay attention to: @@ -132,4 +132,4 @@ Note: originally, this functionality used to be provided as an executable script ## Getting help -If you need help with this repository or have any questions, first check the [FAQ](faq.md) to see if your question has been answered. If your question is not listed or you still need help, contact the MDN team on [chat.mozilla.org#mdn](https://chat.mozilla.org/#/room/#mdn:mozilla.org) or write to us on [Discourse](https://discourse.mozilla-community.org/c/mdn). +If you need help with this repository or have any questions, first check the [FAQ](./faq.md) to see if your question has been answered. If your question is not listed or you still need help, contact the MDN team on [chat.mozilla.org#mdn](https://chat.mozilla.org/#/room/#mdn:mozilla.org) or write to us on [Discourse](https://discourse.mozilla-community.org/c/mdn). diff --git a/docs/data-guidelines/index.md b/docs/data-guidelines/index.md index d7f0b3d671a972..023005379d4954 100644 --- a/docs/data-guidelines/index.md +++ b/docs/data-guidelines/index.md @@ -17,7 +17,7 @@ This decision was made in [#3953, under the expectation that most users are like ### Backported releases -Some browsers have backport releases, where a feature is added or removed in two or more versions at once that do not follow a linear semantic versioning bump (ex. Safari 6.0 was released, then Safari 7.0, and then Safari 6.1). If not otherwise covered by this guideline, use the earliest applicable version (as described in the [Release lines](#release-lines) guideline). In some cases, however, you must set the version number to the following major version. For example, if a new feature was added in Safari 7.0 and in Safari 6.1, then the supported version is 7.0 (not 6 or 6.1). +Some browsers have backport releases, where a feature is added or removed in two or more versions at once that do not follow a linear semantic versioning bump (ex. Safari 6.0 was released, then Safari 7.0, and then Safari 6.1). If not otherwise covered by this guideline, use the earliest applicable version (as described in the [Choosing a version number](#choosing-a-version-number) guideline). In some cases, however, you must set the version number to the following major version. For example, if a new feature was added in Safari 7.0 and in Safari 6.1, then the supported version is 7.0 (not 6 or 6.1). | If the browser and its version is... | then set the version to... | | ------------------------------------ | -------------------------- | diff --git a/docs/faq.md b/docs/faq.md index 86bed096787100..cae54b97baaa24 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -8,7 +8,7 @@ Once a pull request is merged to update BCD, it takes a week or two for a new ve 1. A pull request is reviewed and merged to `main`. 2. Project owners publish a new release of [`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data). - See [Publishing a new version of `@mdn/browser-compat-data`](publishing.md) for details. + See [Publishing a new version of `@mdn/browser-compat-data`](./publishing.md) for details. 3. MDN staff merge a pull request that updates the BCD version in [Yari](https://github.com/mdn/yari), the MDN engine. This typically happens within a day of the release of the npm package. 4. Tables are then generated on MDN Web Docs: diff --git a/docs/matching-browser-releases/index.md b/docs/matching-browser-releases/index.md index 4073f342e73bba..bd0d1899741fd4 100644 --- a/docs/matching-browser-releases/index.md +++ b/docs/matching-browser-releases/index.md @@ -31,7 +31,7 @@ Given a particular Chrome changeset or revision number, you can look up the vers For example, given the string `05b49ea1`, the tool first looks for a match among the full commit changeset numbers, finds none, then looks at the prefixed short commits: -![Screenshot of the Chromium project's Find Releases tool](find-releases-tool.png) +![Screenshot of the Chromium project's Find Releases tool](./find-releases-tool.png) Here, we see that changeset `05b49ea1` was first landed for Chrome 56, but was then backported to Chrome 55 and was presumably shipped there. This assumes the feature was not backed out at some point, and it's important to check on this. @@ -65,7 +65,7 @@ interface HTMLIFrameElement : HTMLElement setter allowPaymentRequest ``` -This indicates that for the `HTMLIFrameElement` interface (representing the members of an `iframe` element), the `allowPaymentRequest` property's value can be neither read not set, essentially meaning the property is not available. This property is part of the [Payment Request API](/en-US/docs/Web/API/Payment_Request_API), which is not yet supported in WebViews. +This indicates that for the `HTMLIFrameElement` interface (representing the members of an `iframe` element), the `allowPaymentRequest` property's value can be neither read not set, essentially meaning the property is not available. This property is part of the [Payment Request API](https://developer.mozilla.org/en-US/docs/Web/API/Payment_Request_API), which is not yet supported in WebViews. If only an interface line is included in the exclusion list, then the entire interface is unavailable in WebViews. @@ -154,17 +154,17 @@ If you have the bug number corresponding to the bug that implemented the feature Consider [bug 1435161](https://bugzil.la/1435161). This bug covers implementing the `PaymentResponse.retry()` method. If you look at that bug, you'll see the information you need right there at the top: -![Screenshot showing "RESOLVED FIXED in Firefox 64" at the top of the Bugzilla screen](bugzilla-fixedin-top.png) +![Screenshot showing "RESOLVED FIXED in Firefox 64" at the top of the Bugzilla screen](./bugzilla-fixedin-top.png) Right below the bug summary, you see the text "RESOLVED FIXED in Firefox 64". This corresponds to the presence of the tracking flag named `firefox45` having the value `fixed`. On older bugs, before the release-numbered tracking flags were added, you might instead find one of these: - A tracking flag named `relnote-firefox` with the status set to the version of Firefox the feature arrived in. This tracking flag is intended to indicate when a feature needs to be mentioned in the release notes for the browser, but serves just as well to tell us when a feature was added. - ![Screenshot showing the relnote-firefox tracking flag used to indicate a version number](bugzilla-relnote-firefox.png) + ![Screenshot showing the relnote-firefox tracking flag used to indicate a version number](./bugzilla-relnote-firefox.png) - The Target field in the Tracking group in Bugzilla is set to `mozillaN`, where `N` is the version number of Firefox. The trick to watch for is that this is sometimes inaccurate, as it represents when it was hoped to ship, not necessarily when it was actually released. Be sure to review the comments on the bug to ensure that it didn't miss its planned release. - ![Screenshot showing the Bugzilla Target field indicating a release target of "mozilla15" or Firefox 15](bugzilla-target.png) + ![Screenshot showing the Bugzilla Target field indicating a release target of "mozilla15" or Firefox 15](./bugzilla-target.png) ### From the name of a Web API interface or member @@ -193,14 +193,14 @@ A web API feature change corresponds to adding, removing, or altering the signat - A constant defined by an API's specification - A data type (enum, typedef, or similar) -The easiest way to identify the compatibility of a feature is to look for when the feature was added to or altered to match the compatibility point you're looking for within the [WebIDL](/en-US/docs/Glossary/WebIDL) file that describes the corresponding interface. There are a few ways you can locate this file, depending on how the API is implemented and how old it is. From most to least likely to work, here they are: +The easiest way to identify the compatibility of a feature is to look for when the feature was added to or altered to match the compatibility point you're looking for within the [WebIDL](https://developer.mozilla.org/en-US/docs/Glossary/WebIDL) file that describes the corresponding interface. There are a few ways you can locate this file, depending on how the API is implemented and how old it is. From most to least likely to work, here they are: 1. For a given interface named `InterfaceName`, go to [DXR](https://searchfox.org/mozilla-central/source/) and type file:InterfaceName.webidl in the search box at the top of the page and pressing Enter. You will probably have to then click on the name of the file in a list of files (usually only a one-file-long list). -2. If the interface isn't found, then search for it by looking for the main interface in the API. For example, a large number of the interfaces, types, and so on for [WebRTC](/en-US/docs/Web/API/WebRTC_API) are located in the file `RTCPeerConnection.webidl` in the Firefox source code, so if you don't find a WebRTC interface by its name, look in that file instead. +2. If the interface isn't found, then search for it by looking for the main interface in the API. For example, a large number of the interfaces, types, and so on for [WebRTC](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API) are located in the file `RTCPeerConnection.webidl` in the Firefox source code, so if you don't find a WebRTC interface by its name, look in that file instead. Once in the WebIDL file, click the "Blame" link under "VCS Links" in the Navigation box near the top-right corner of the DXR page. -![Screenshot of the DXR Navigation box](dxr-navigation-box.png) +![Screenshot of the DXR Navigation box](./dxr-navigation-box.png) Once in the blame view, hover the mouse cursor over the revision number at the left side of the WebIDL on the same line as (or the first revision number found immediately above) the line of WebIDL corresponding to the feature you're interested in. For example, if you're looking for when the `RTCPeerConnection` method `addTrack()` was added to Firefox: diff --git a/docs/publishing.md b/docs/publishing.md index e4bb817bc9106a..a1132161811470 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -1,6 +1,6 @@ # Publishing a new version of `@mdn/browser-compat-data` -[Project owners](/GOVERNANCE.md#owners) publish new releases of [`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data) on npm, usually every Tuesday and Friday. +[Project owners](./GOVERNANCE.md#owners) publish new releases of [`@mdn/browser-compat-data`](https://www.npmjs.com/package/@mdn/browser-compat-data) on npm, usually every Tuesday and Friday. MDN staff then deploy the package to the MDN site, usually every Thursday (MDN never deploys to production on Fridays). ## Before you begin diff --git a/release_notes/v0.md b/release_notes/v0.md index ca328601e2e949..32d8520050c84f 100644 --- a/release_notes/v0.md +++ b/release_notes/v0.md @@ -400,7 +400,7 @@ March 28, 2019 **Notable changes** -- [`matches` objects](schemas/compat-data-schema.md#the-matches-object) have been added to the schema.(https://github.com/mdn/browser-compat-data/pull/3631) +- [`matches` objects](./schemas/compat-data-schema.md#the-matches-object) have been added to the schema.(https://github.com/mdn/browser-compat-data/pull/3631) **Statistics** diff --git a/release_notes/v1.md b/release_notes/v1.md index bd8c8fab04da42..8ab1f23d532725 100644 --- a/release_notes/v1.md +++ b/release_notes/v1.md @@ -351,7 +351,7 @@ May 28, 2020 **Notable changes** -- The following [irrelevant features](docs/data-guidelines/index.md#removal-of-irrelevant-features) have been removed: +- The following [irrelevant features](./docs/data-guidelines/index.md#removal-of-irrelevant-features) have been removed: - `javascript.builtins.String.quote` ([#6207](https://github.com/mdn/browser-compat-data/issues/6207)) - `javascript.builtins.String.replace.flags` ([#6206](https://github.com/mdn/browser-compat-data/issues/6206)) - `api.LocalFileSystem` and `api.LocalFileSystemSync` ([#6163](https://github.com/mdn/browser-compat-data/issues/6163)) @@ -369,12 +369,12 @@ May 21, 2020 **Notable changes** -- The following [irrelevant features](docs/data-guidelines/index.md#removal-of-irrelevant-features) have been removed: +- The following [irrelevant features](./docs/data-guidelines/index.md#removal-of-irrelevant-features) have been removed: - `javascript.builtins.Date.toLocaleFormat` ([#6183](https://github.com/mdn/browser-compat-data/issues/6183)) - `javascript.builtins.String.match.flags` ([#6184](https://github.com/mdn/browser-compat-data/issues/6184)) - `javascript.statements.try_catch.conditional_clauses` ([#6192](https://github.com/mdn/browser-compat-data/issues/6192)) - `javascript.statements.default.exports` has moved to `javascript.statements.exports.default` (see [#5869](https://github.com/mdn/browser-compat-data/issues/5869)). -- A new guideline for how [Permissions API permissions data](docs/data-guidelines/api.md#permissions-api-permissions-permissionname_permission) is stored has been accepted and the descriptions have been fixed, see https://github.com/mdn/browser-compat-data/pull/6156. +- A new guideline for how [Permissions API permissions data](./docs/data-guidelines/api.md#permissions-api-permissions-permissionname_permission) is stored has been accepted and the descriptions have been fixed, see https://github.com/mdn/browser-compat-data/pull/6156. **Statistics** diff --git a/release_notes/v2.md b/release_notes/v2.md index 16a31b71a7de02..96ab2e90b37cc2 100644 --- a/release_notes/v2.md +++ b/release_notes/v2.md @@ -7,7 +7,7 @@ November 19, 2020 **Notable changes** - Internet Explorer version `"≤6"` is now an accepted value, to reflect testing limitations for older versions ([#7337](https://github.com/mdn/browser-compat-data/issues/7337)) -- The following features were [removed as irrelevant](docs/data-guidelines/index.md#removal-of-irrelevant-features): +- The following features were [removed as irrelevant](./docs/data-guidelines/index.md#removal-of-irrelevant-features): - `api.MediaQueryListListener` ([#7210](https://github.com/mdn/browser-compat-data/issues/7210)) - `api.IDBVersionChangeRequest.setVersion` ([#6934](https://github.com/mdn/browser-compat-data/issues/6934)) - `api.IDBVersionChangeRequest` ([#7411](https://github.com/mdn/browser-compat-data/issues/7411)) diff --git a/release_notes/v3.md b/release_notes/v3.md index ac41a2bbfa47a9..dbb0394619b54f 100644 --- a/release_notes/v3.md +++ b/release_notes/v3.md @@ -1119,7 +1119,7 @@ March 4, 2021 - `mathml.elements.mtd.groupalign` - `mathml.elements.mtr.groupalign` -- The following constants have been removed, under the recently-adopted [_Constants_ guideline](docs/data-guidelines/api.md#constants) ([#9195](https://github.com/mdn/browser-compat-data/pull/9195)): +- The following constants have been removed, under the recently-adopted [_Constants_ guideline](./docs/data-guidelines/api.md#constants) ([#9195](https://github.com/mdn/browser-compat-data/pull/9195)): - `api.KeyboardEvent.DOM_KEY_LOCATION_LEFT` - `api.KeyboardEvent.DOM_KEY_LOCATION_NUMPAD` @@ -1199,7 +1199,7 @@ February 11, 2021 **Notable changes** -- We've adopted [a new data guideline for interface mixins](docs/data-guidelines/api.md#mixins). From v3.1.0, new data for [interface mixins](https://webidl.spec.whatwg.org/#idl-interface-mixins) will be represented as subfeatures of their exposed interfaces, instead of fictitious mixin interfaces. +- We've adopted [a new data guideline for interface mixins](./docs/data-guidelines/api.md#mixins). From v3.1.0, new data for [interface mixins](https://webidl.spec.whatwg.org/#idl-interface-mixins) will be represented as subfeatures of their exposed interfaces, instead of fictitious mixin interfaces. For example, `HTMLHyperlinkElementUtils` attributes are now represented on `HTMLAnchorElement` and `HTMLAreaElement` directly. @@ -1241,7 +1241,7 @@ February 4, 2021 **Notable changes** -- `api.WEBGL_color_buffer_float.RGB32F_EXT`, a constant, was removed following the [_Constants_ data guideline](docs/data-guidelines/api.md#constants) ([#8934](https://github.com/mdn/browser-compat-data/pull/8934)) +- `api.WEBGL_color_buffer_float.RGB32F_EXT`, a constant, was removed following the [_Constants_ data guideline](./docs/data-guidelines/api.md#constants) ([#8934](https://github.com/mdn/browser-compat-data/pull/8934)) **Statistics** @@ -1349,7 +1349,7 @@ Review the changes below for details. - Node.js versions `0.10` and `0.12` were replaced by their full SemVer values, `0.10.0` and `0.12.0`, respectively. ([#7491](https://github.com/mdn/browser-compat-data/issues/7491), [#7492](https://github.com/mdn/browser-compat-data/issues/7492)) - Many high-level namespaces in the package were [documented](https://github.com/mdn/browser-compat-data#package-contents) and [a formal Semantic Versioning policy was introduced](https://github.com/mdn/browser-compat-data#semantic-versioning-policy). ([#7615](https://github.com/mdn/browser-compat-data/issues/7615)) - Data in `javascript` requires version number data; the `javascript` data no longer contains any `null` or `true` values. ([#7607](https://github.com/mdn/browser-compat-data/issues/7607)) -- [_Addition of browsers_](docs/data-guidelines/browsers.md#addition-of-browsers) and [_Removal of browsers_](docs/data-guidelines/browsers.md#removal-of-browsers) data guidelines were adopted to document requirements to add or remove a browser or engine from package. ([#7244](https://github.com/mdn/browser-compat-data/issues/7244)) +- [_Addition of browsers_](./docs/data-guidelines/browsers.md#addition-of-browsers) and [_Removal of browsers_](./docs/data-guidelines/browsers.md#removal-of-browsers) data guidelines were adopted to document requirements to add or remove a browser or engine from package. ([#7244](https://github.com/mdn/browser-compat-data/issues/7244)) - The following features were removed as irrelevant: - `api.HTMLAnchorElement.media` ([#7538](https://github.com/mdn/browser-compat-data/issues/7538)) - `api.HTMLAreaElement.hreflang` ([#7539](https://github.com/mdn/browser-compat-data/issues/7539)) diff --git a/schemas/compat-data-schema.md b/schemas/compat-data-schema.md index 31155ab44f6f4b..102cbe9dd8b84f 100644 --- a/schemas/compat-data-schema.md +++ b/schemas/compat-data-schema.md @@ -30,7 +30,7 @@ Compatibility data is organized in top-level directories for each broad area cov ### File and folder breakdown -The JSON files contain [feature identifiers](#feature-identifiers), which are relevant for accessing the data. Except for the top-level directories, the file and sub-folder hierarchies aren't of any meaning for the exports. Compatibility data can be stored in a single large file or might be divided in smaller files and placed into subfolders. +The JSON files contain [feature identifiers](#features), which are relevant for accessing the data. Except for the top-level directories, the file and sub-folder hierarchies aren't of any meaning for the exports. Compatibility data can be stored in a single large file or might be divided in smaller files and placed into subfolders. ## Understanding the schema @@ -72,7 +72,7 @@ When an identifier has a `__compat` block, it represents its basic support, indi To add a sub-feature, a new identifier is added below the main feature at the level of a `__compat` object (see the sub-features "start" and "end" above). The same could be done for sub-sub-features. There is no depth limit. -See [Data guidelines](/docs/data-guidelines/index.md) for more information about feature naming conventions and other best practices. +See [Data guidelines](./docs/data-guidelines/index.md) for more information about feature naming conventions and other best practices. ### The `__compat` object @@ -190,7 +190,7 @@ The `__compat` object consists of the following: - `web-features`: A namespace to tag features belonging to a web platform feature group as defined by [web-platform-dx/web-features](https://github.com/web-platform-dx/web-features/blob/main/feature-group-definitions/README.md). - For more information, see the [tagging data guidelines](/docs/data-guidelines/tags.md). + For more information, see the [tagging data guidelines](./docs/data-guidelines/tags.md). #### Browser identifiers