diff --git a/README.md b/README.md index 437f8f26..a7ddba4e 100644 --- a/README.md +++ b/README.md @@ -67,14 +67,8 @@ definitions: the number of breaking changes. This is currently WIP and some members may be added or removed. -## Web IDL version +### Generation -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). +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. 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. 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();