Skip to content

Commit 40d0e00

Browse files
committed
refactor(docs): point people to docs on website instead of .md docs
The docs on the website are prettier. Point people there instead of the uglier .md files.
1 parent 54994eb commit 40d0e00

File tree

8 files changed

+17
-365
lines changed

8 files changed

+17
-365
lines changed

.github/workflows/build-and-test-dev.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
pull_request:
88
types: [opened, synchronize]
99

10-
# Based on docs/BUILDING.md.
10+
# Based on website/public/contribute/build-from-source/.
1111
jobs:
1212
build:
1313
name: ${{ matrix.toolchain.name }}
@@ -36,7 +36,7 @@ jobs:
3636
- name: 1. Configure with CMake
3737
run: |
3838
mkdir build ; cd build ; ${{ matrix.toolchain.extra_environment }} cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .. ; cd "$OLDPWD"
39-
if ! [ -f docs/BUILDING.md ]; then
39+
if ! [ -f docs/FUZZING.md ]; then
4040
printf 'error: cwd changed unexpectedly\n' >&2
4141
exit 1
4242
fi

.github/workflows/simple-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
uses: actions/checkout@v2
3030

3131
- name: build
32-
# Keep in sync with "quick build" in docs/BUILDING.md.
32+
# Keep in sync with "single-command build" in website/public/contribute/build-from-source/.
3333
run: '"${CXX}" ${CXXFLAGS} -o quick-lint-js -std=gnu++17 -I src -I vendor/boost -I vendor/simdjson/include -I vendor/simdjson/src -D_LIBCPP_HIDE_FROM_ABI_PER_TU_BY_DEFAULT=1 -D_LIBCPP_INLINE_VISIBILITY="__attribute__((internal_linkage))" src/quick-lint-js/*.cpp src/quick-lint-js/*/*.cpp vendor/boost/libs/container/src/*.cpp vendor/boost/libs/container/src/alloc_lib.c vendor/simdjson/src/simdjson.cpp -pthread'
3434

3535
# quick-lint-js finds bugs in JavaScript programs.

README.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ quick-lint-js finds many bugs, including:
1616
See [installation instructions](https://quick-lint-js.com/install/) for how
1717
to install quick-lint-js' CLI, LSP server, and editor plugins.
1818

19-
See [build instructions](docs/BUILDING.md) for how to build quick-lint-js for
20-
development.
19+
## Contributing
20+
21+
If you want to make quick-lint-js better, see our
22+
[contributing guides](https://quick-lint-js.com/contribute/).
2123

2224
## Contact
2325

@@ -29,25 +31,6 @@ development.
2931
**Security bug reports (private disclosure)**: email
3032
3133

32-
## Values
33-
34-
* **Performance**. You use quick-lint-js in text editors and IDEs to show bugs
35-
as they are written. quick-lint-js must be *fast* to make feedback *responsive*.
36-
* **Small design**. The less infrastructure and developer conveniences used
37-
within quick-lint-js, the less time quick-lint-js wastes due to this bloat.
38-
* **Few features**. Features add run-time costs. With fewer features,
39-
quick-lint-js gives you feedback sooner.
40-
41-
* **High signal**. quick-lint-js finds bugs, not nitpicks. You can use
42-
quick-lint-js in *any* project, no matter the size or style.
43-
* **No opinions**. quick-lint-js doesn't complain about style issues, like
44-
using `'strings'` vs `"strings"`. It complains about real bugs which
45-
everyone agrees are bugs.
46-
* **No false positives**. If quick-lint-js complains, you know it's a bug in
47-
your code.
48-
* **No configuration**. quick-lint-js works out-of-the-box. You don't need
49-
configuration files to tell quick-lint-js what buggy code looks like.
50-
5134
[Libera.Chat]: https://libera.chat/
5235
[quick-lint-js-irc-web]: https://kiwiirc.com/nextclient/irc.libera.chat/#quick-lint-js
5336
[quick-lint-js]: https://quick-lint-js.com/

benchmark/benchmark-lsp/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Install the LSP servers you want to benchmark:
2121

2222
Install a compiler which supports C++20 coroutines (such as Clang version 12).
2323
[Configure quick-lint-js using CMake with
24-
`-DQUICK_LINT_JS_ENABLE_BENCHMARKS=YES`](../../docs/BUILDING.md). Build the
24+
`-DQUICK_LINT_JS_ENABLE_BENCHMARKS=YES`][build-from-source]. Build the
2525
`quick-lint-js-benchmark-lsp-servers` target. For example, on Linux:
2626

2727
$ mkdir build
@@ -121,4 +121,5 @@ Work (timed):
121121

122122
[Deno]: https://deno.land/
123123
[Stack]: https://haskellstack.org/
124+
[build-from-source]: https://quick-lint-js.com/contribute/build-from-source/
124125
[install-rslint]: https://rslint.org/guide/

docs/BUILDING.md

Lines changed: 0 additions & 292 deletions
This file was deleted.

0 commit comments

Comments
 (0)