From 3cf0a8af164bb24c9efbc3eb864219aaeb257400 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Wed, 28 Feb 2024 12:19:04 -0800 Subject: [PATCH 1/3] Move IDL version details, etc to tool directory Offers very little benefit for almost all users --- README.md | 12 ------------ tool/README.md | 11 +++++++++++ tool/update_bindings.dart | 2 +- 3 files changed, 12 insertions(+), 13 deletions(-) create mode 100644 tool/README.md diff --git a/README.md b/README.md index 437f8f26..99861077 100644 --- a/README.md +++ b/README.md @@ -66,15 +66,3 @@ definitions: that is standards track and supported on Chrome, Firefox, and Safari to reduce the number of breaking changes. This is currently WIP and some members may be added or removed. - -## Web IDL version - -Based on: - - -- @webref/idl [3.43.1](https://www.npmjs.com/package/@webref/idl/v/3.43.1) -- @webref/css [6.11.0](https://www.npmjs.com/package/@webref/css/v/6.11.0) - - -For instructions on re-generating the DOM bindings, see the -[generator docs](tool/generator/README.md). diff --git a/tool/README.md b/tool/README.md new file mode 100644 index 00000000..ccbb1e76 --- /dev/null +++ b/tool/README.md @@ -0,0 +1,11 @@ +## Web IDL version + +Based on: + + +- @webref/idl [3.43.1](https://www.npmjs.com/package/@webref/idl/v/3.43.1) +- @webref/css [6.11.0](https://www.npmjs.com/package/@webref/css/v/6.11.0) + + +For instructions on re-generating the DOM bindings, see the +[generator docs](generator/README.md). diff --git a/tool/update_bindings.dart b/tool/update_bindings.dart index a6001b0d..459a6e84 100644 --- a/tool/update_bindings.dart +++ b/tool/update_bindings.dart @@ -93,7 +93,7 @@ $_usage'''); // Update readme. final readmeFile = File( - p.normalize(p.join(_bindingsGeneratorPath, '..', '..', 'README.md')), + p.normalize(p.join(_bindingsGeneratorPath, '..', 'README.md')), ); final sourceContent = readmeFile.readAsStringSync(); From b376f8a17a0b2dff48a9f80372e586b55035433c Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Wed, 28 Feb 2024 12:37:04 -0800 Subject: [PATCH 2/3] fix a link --- third_party/mdn/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third_party/mdn/README.md b/third_party/mdn/README.md index f99c331b..6b45f727 100644 --- a/third_party/mdn/README.md +++ b/third_party/mdn/README.md @@ -10,5 +10,5 @@ See [LICENSE] for the license this content is under. ## Process -See [../../tool/scrape_mdn.dart] for the script which collects the -documentation information. +See [the script](../../tool/scrape_mdn.dart) which collects the documentation +information. From d46651abc28614da31cbd2b53eb4917053684195 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Wed, 28 Feb 2024 13:29:26 -0800 Subject: [PATCH 3/3] beter --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 99861077..a7ddba4e 100644 --- a/README.md +++ b/README.md @@ -66,3 +66,9 @@ definitions: that is standards track and supported on Chrome, Firefox, and Safari to reduce the number of breaking changes. This is currently WIP and some members may be added or removed. + +### Generation + +Most of the APIs in this package are generated from public assets. +See the [tool directory](https://github.com/dart-lang/web/tree/main/tool) in the +source repository to learn more.