Skip to content

Commit

Permalink
docs(book): Fix broken internal links
Browse files Browse the repository at this point in the history
When refering to `README.md` from anywhere outside the SUMMARY.md, it will not
correctly translate them into links to `index.html`, but refering to `index.md`
will. This also moves `./test-sets` directly into `./reference` and removes some
overly specific cli reference sections.
  • Loading branch information
tingerrr committed Jul 25, 2024
1 parent fc9bbb3 commit da7c895
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/book/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ After the quick start, a few guides delve deeper into some advanced topics.
- [Setting Up CI](./guides/ci.md) shows how to set up `typst-test` to continuously test all changes to your package.

The later sections of the book are a technical reference to `typst-test` and its various features or concepts.
- [Tests](./reference/tests.md) outlines which types of tests `typst-test` supports, how they can be customized and which features are offered within the test scripts.
- [Test Set Language](./reference/test-set-dsl.md) defines the test set language and its built in test sets.
- [Tests](./reference/tests/index.md) outlines which types of tests `typst-test` supports, how they can be customized and which features are offered within the test scripts.
- [Test Set Language](./reference/test-sets/index.md) defines the test set language and its built in test sets.
- [Configuration Schema](./reference/config.md) lists all existing config options, their expected types and default values.
- [Command Line Tool](./reference/cli.md) goes over `typst-test`s various sub commands, arguments and options.
- [Command Line Tool](./reference/cli/index.md) goes over `typst-test`s various sub commands, arguments and options.

17 changes: 3 additions & 14 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,12 @@
- [Reference Kinds]()
- [Annotations]()
- [Directory Structure]()
- [Test Set Language](./test-sets/README.md)
- [Grammar](./test-sets/grammar.md)
- [Built-in Test Sets](./test-sets/built-in.md)
- [Test Set Language](./reference/test-sets/README.md)
- [Grammar](./reference/test-sets/grammar.md)
- [Built-in Test Sets](./reference/test-sets/built-in.md)
- [Configuration Schema]()
- [Template]()
- [Hooks]()
- [Command Line Tool]()
- [Global Options]()
- [Command Reference]()
- [init]()
- [uninit]()
- [status]()
- [list]()
- [compile]()
- [run]()
- [update]()
- [add]()
- [edit]()
- [remove]()
- [util]()
4 changes: 3 additions & 1 deletion docs/book/src/guides/test-sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Tying it all together, we can describe what this expression matches in a sentenc

> Select all tests which are not marked ignore and are inside a module starting with `foo-`, include also the test `bar/baz`.
Trying to describe this relationship using options on the command line would be cumbersome, error prone and, depending on the options present, impossible.
Trying to describe this relationship using options on the command line would be cumbersome, error prone and, depending on the options present, impossible. [^ref]

## Default Test Sets
Many operations take either a set of tests as positional arguments, which are matched exactly, or a test set expression.
Expand Down Expand Up @@ -99,3 +99,5 @@ Specifically the `all` and `none` test sets can be used as identity sets for cer

Some of the syntax used in test sets may interfere with your shell, especially the use of whitespace.
Use non-interpreting quotes around the test set expression (commonly single quotes `'...'`) to avoid interpreting them as shell specific sequences.

[^ref]: To get a more complete look at test sets, take a look at the [reference](../reference/test-sets.md).
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit da7c895

Please sign in to comment.