TudbuT/conduit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: ignore development.md and contributing.md from lychee

Browse source 
and update 2 other nix references

Signed-off-by: strawberry <strawberry@puppygock.gay>
Signed-off-by: morguldir <morguldir@protonmail.com>
This commit is contained in:
strawberry 2024-09-08 10:24:38 -04:00 • committed by morguldir
parent 3e0d404fb4
commit c47337f3db
No known key found for this signature in database
GPG key ID: 5A6025D4F6E7A8A3
4 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/deploying/generic.md
View file

@ -18,7 +18,7 @@ These binaries have jemalloc and io_uring statically linked and included with
them. them.
Alternatively, you may compile the binary yourself. We recommend using Alternatively, you may compile the binary yourself. We recommend using
[Lix](https://lix.systems) to build conduwuit as this has the most guaranteed Nix (or [Lix](https://lix.systems) to build conduwuit as this has the most guaranteed
reproducibiltiy and easiest to get a build environment and output going. reproducibiltiy and easiest to get a build environment and output going.
Otherwise, follow standard Rust project build guides (installing git and cloning Otherwise, follow standard Rust project build guides (installing git and cloning

5
docs/development/testing.md
View file

@ -5,8 +5,8 @@
Have a look at [Complement's repository][complement] for an explanation of what Have a look at [Complement's repository][complement] for an explanation of what
it is. it is.
To test against Complement, with [Lix][lix] and direnv installed and set up, you To test against Complement, with Nix (or [Lix](https://lix.systems) and direnv installed
can: and set up, you can:
* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl * Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl
./path/to/results.jsonl` to build a Complement image, run the tests, and output ./path/to/results.jsonl` to build a Complement image, run the tests, and output
@ -18,6 +18,5 @@ Complement OCI image outputted to `result` (it's a `.tar.gz` file)
output from the commit/revision you want to test (e.g. from main) output from the commit/revision you want to test (e.g. from main)
[here][ci-workflows] [here][ci-workflows]
[lix]: https://lix.systems/
[ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo [ci-workflows]: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=event%3Apush+is%3Asuccess+actor%3Agirlbossceo
[complement]: https://github.com/matrix-org/complement [complement]: https://github.com/matrix-org/complement

2
engage.toml
View file

@ -152,7 +152,7 @@ cargo clippy \
[[task]] [[task]]
name = "lychee" name = "lychee"
group = "lints" group = "lints"
script = "lychee --verbose --offline docs *.md --exclude development.md" script = "lychee --verbose --offline docs *.md --exclude development.md --exclude contributing.md --exclude testing.md"
[[task]] [[task]]
name = "markdownlint" name = "markdownlint"

2
nix/pkgs/book/default.nix
View file

@ -14,8 +14,10 @@ stdenv.mkDerivation {
include = [ include = [
"book.toml" "book.toml"
"conduwuit-example.toml" "conduwuit-example.toml"
"CODE_OF_CONDUCT.md"
"CONTRIBUTING.md" "CONTRIBUTING.md"
"README.md" "README.md"
"development.md"
"debian/conduwuit.service" "debian/conduwuit.service"
"debian/README.md" "debian/README.md"
"arch/conduwuit.service" "arch/conduwuit.service"