From 43f62ccaaff76f3652107c5121bdd708c0bfb9ab Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Sat, 7 Sep 2024 09:40:08 -0700 Subject: [PATCH] docs: move AW screenie to nested page --- README.md | 6 +++--- docs/formatting.md | 4 +++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ce129cd6..8e645768 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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). diff --git a/docs/formatting.md b/docs/formatting.md index ba38165d..f95f50fa 100644 --- a/docs/formatting.md +++ b/docs/formatting.md @@ -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: