Skip to content

Commit d885bc9

Browse files
authored
Update docs to point at the FAQ and general docs (#3620)
Closes #3617
1 parent df76f89 commit d885bc9

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

build_runner/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 2.4.8-wip
2+
3+
- Update README.md to point to the FAQ and other docs.
4+
15
## 2.4.7
26

37
- Fix broken link in README.md.

build_runner/README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
2121

2222
> **NOTE**: Are you a user of this package? You may be interested in
2323
> simplified user-facing documentation, such as our
24-
> [getting started guide][getting-started-link].
24+
> [getting started guide][getting-started-link] and [faq][faq-link].
2525
26-
[getting-started-link]: https://goo.gl/b9o2j6
26+
[getting-started-link]: https://github.com/dart-lang/build/blob/master/docs/getting_started.md
27+
[faq-link]: https://github.com/dart-lang/build/blob/master/docs/faq.md
28+
[other-docs-link]: https://github.com/dart-lang/build/tree/master/docs
2729

2830
* [Installation](#installation)
2931
* [Usage](#usage)
@@ -32,13 +34,14 @@ rebuilds are _incremental_ - inspired by tools such as [Bazel][].
3234
* [Outputs](#outputs)
3335
* [Source control](#source-control)
3436
* [Publishing packages](#publishing-packages)
37+
* [Docs](#docs)
3538
* [Contributing](#contributing)
3639
* [Testing](#testing)
3740

3841
## Installation
3942

4043
This package is intended to support development of Dart projects with
41-
[`package:build`][]. In general, add it to your [`pubspec.yaml`][pubspec]
44+
[`package:build`][]. In general, add it to your [`pubspec.yaml`][pubspec]
4245
as a [dev_dependencies][] by running the following command.
4346

4447
```console
@@ -56,6 +59,12 @@ also provide a `build.yaml` with the configuration. See the
5659

5760
To have web code compiled to js add a `dev_dependency` on `build_web_compilers`.
5861

62+
## Docs
63+
64+
More comprehensive documentation is stored in this repository, under the
65+
[docs][other-docs-link] directory. If you find something is undocumented, please
66+
file an issue.
67+
5968
### Built-in Commands
6069

6170
The `build_runner` package exposes a binary by the same name, which can be

build_runner/pubspec.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: build_runner
2-
version: 2.4.7
2+
version: 2.4.8-wip
33
description: A build system for Dart code generation and modular compilation.
44
repository: https://github.com/dart-lang/build/tree/master/build_runner
55

0 commit comments

Comments
 (0)