Skip to content

Commit

Permalink
docs: move AW screenie to nested page
Browse files Browse the repository at this point in the history
  • Loading branch information
alexeagle committed Sep 7, 2024
1 parent a44f4b3 commit 43f62cc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ See [Formatting](./docs/formatting.md) for more ways to use the formatter.

Demo:
![pre-commit format](./docs/format-demo.svg)
![format on CI](./docs/format-ci-demo.png)

### Lint

Expand All @@ -121,10 +120,11 @@ To lint code, we recommend using the [Aspect CLI] to get the missing `lint` comm
For example, running `bazel lint //src:all` prints lint warnings to the terminal for all targets in the `//src` package.
Suggested fixes from the linter tools are presented interactively.

![bazel lint demo](./docs/lint-fix-demo.svg)

See [Linting](./docs/linting.md) for more ways to use the linter.

Demo:
![bazel lint demo](./docs/lint-fix-demo.svg)

### Ignoring files

The linters only visit files that are part of the Bazel dependency graph (listed as `srcs` to some library target).
Expand Down
4 changes: 3 additions & 1 deletion docs/formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,9 @@ $ chmod u+x .git/hooks/pre-commit
### Check that files are already formatted

We recommend using [Aspect Workflows] to hook up the CI check to notify developers of formatting changes,
and offer to apply them as a suggestion in the code review thread.
and supply a patch file that can be locally applied.

![format on CI](./docs/format-ci-demo.png)

To set this up manually, there are two supported methods:

Expand Down

0 comments on commit 43f62cc

Please sign in to comment.