Update docs to point at the FAQ and general docs (#3620)

Closes #3617
dart-lang · Dec 4, 2023 · d885bc9 · d885bc9
1 parent df76f89
commit d885bc9
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/build_runner/CHANGELOG.md b/build_runner/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.4.8-wip
+
+- Update README.md to point to the FAQ and other docs.
+
 ## 2.4.7
 
 - Fix broken link in README.md.

diff --git a/build_runner/README.md b/build_runner/README.md
@@ -21,9 +21,11 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
 
 > **NOTE**: Are you a user of this package? You may be interested in
 > simplified user-facing documentation, such as our
-> [getting started guide][getting-started-link].
+> [getting started guide][getting-started-link] and [faq][faq-link].
 
-[getting-started-link]: https://goo.gl/b9o2j6
+[getting-started-link]: https://github.com/dart-lang/build/blob/master/docs/getting_started.md
+[faq-link]: https://github.com/dart-lang/build/blob/master/docs/faq.md
+[other-docs-link]: https://github.com/dart-lang/build/tree/master/docs
 
 * [Installation](#installation)
 * [Usage](#usage)
@@ -32,13 +34,14 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
   * [Outputs](#outputs)
   * [Source control](#source-control)
   * [Publishing packages](#publishing-packages)
+* [Docs](#docs)
 * [Contributing](#contributing)
   * [Testing](#testing)
 
 ## Installation
 
 This package is intended to support development of Dart projects with
-[`package:build`][]. In general, add it to your [`pubspec.yaml`][pubspec] 
+[`package:build`][]. In general, add it to your [`pubspec.yaml`][pubspec]
 as a [dev_dependencies][] by running the following command.
 
 ```console
@@ -56,6 +59,12 @@ also provide a `build.yaml` with the configuration. See the
 
 To have web code compiled to js add a `dev_dependency` on `build_web_compilers`.
 
+## Docs
+
+More comprehensive documentation is stored in this repository, under the
+[docs][other-docs-link] directory. If you find something is undocumented, please
+file an issue.
+
 ### Built-in Commands
 
 The `build_runner` package exposes a binary by the same name, which can be

diff --git a/build_runner/pubspec.yaml b/build_runner/pubspec.yaml
@@ -1,5 +1,5 @@
 name: build_runner
-version: 2.4.7
+version: 2.4.8-wip
 description: A build system for Dart code generation and modular compilation.
 repository: https://github.com/dart-lang/build/tree/master/build_runner