diff --git a/docs/website/docs/features/async.md b/docs/website/docs/features/async.md index 43bff15..09206f0 100644 --- a/docs/website/docs/features/async.md +++ b/docs/website/docs/features/async.md @@ -1,4 +1,4 @@ -# Asynchronous operations +# Control asynchronous operations in your Kotlin tests A test may need to execute other tasks concurrently with itself. There are two categories of concurrent tasks: diff --git a/docs/website/docs/features/compat-arrow.md b/docs/website/docs/features/compat-arrow.md index 16739c8..5683ba1 100644 --- a/docs/website/docs/features/compat-arrow.md +++ b/docs/website/docs/features/compat-arrow.md @@ -1,4 +1,4 @@ -# Arrow typed errors +# Use Arrow typed errors in your Kotlin tests [Arrow typed errors](https://arrow-kt.io/learn/typed-errors/working-with-typed-errors/) are a powerful way to declare the possible failure cases of a function. Because failure situations are encoded directly in the function's type (unlike exceptions), we can use type parameters to create abstractions over certain failure cases to better handle them. diff --git a/docs/website/docs/features/compat-gradle.md b/docs/website/docs/features/compat-gradle.md index 18b3ce0..1d327af 100644 --- a/docs/website/docs/features/compat-gradle.md +++ b/docs/website/docs/features/compat-gradle.md @@ -1,4 +1,4 @@ -# Gradle plugins +# Test Gradle plugins with Kotlin Gradle build logic can often become quite complex. Much like production code, it should be well tested to discover edge cases. diff --git a/docs/website/docs/features/compat-ktor.md b/docs/website/docs/features/compat-ktor.md index 72738c0..4f98046 100644 --- a/docs/website/docs/features/compat-ktor.md +++ b/docs/website/docs/features/compat-ktor.md @@ -1,4 +1,4 @@ -# Ktor +# Integrate Ktor within your Kotlin tests [Ktor](https://ktor.io/) is a popular, coroutine-first HTTP library developed by JetBrains. Ktor allows developing client and server applications, allowing to share code between all platforms and roles. diff --git a/docs/website/docs/features/files.md b/docs/website/docs/features/files.md index a66e6d6..b008850 100644 --- a/docs/website/docs/features/files.md +++ b/docs/website/docs/features/files.md @@ -1,4 +1,4 @@ -# Files +# Control files in your Kotlin tests When testing some file-based tools, it may be necessary to create temporary files or directories, execute a test, and then observe the contents of the files. diff --git a/docs/website/docs/features/finalizers.md b/docs/website/docs/features/finalizers.md index 398bced..f9eacd6 100644 --- a/docs/website/docs/features/finalizers.md +++ b/docs/website/docs/features/finalizers.md @@ -1,4 +1,4 @@ -# Finalizers +# Declare finalizers in your Kotlin tests [Finalizers](https://prepared.opensavvy.dev/api-docs/suite/opensavvy.prepared.suite/clean-up.html) allow to execute code at the end of the test. diff --git a/docs/website/docs/features/index.md b/docs/website/docs/features/index.md index 49dbd2d..0cd10d0 100644 --- a/docs/website/docs/features/index.md +++ b/docs/website/docs/features/index.md @@ -1,4 +1,4 @@ -# Features overview +# Discover the features of the Prepared test DSL for Kotlin Prepared adds many helpers to facilitate writing tests. To learn about them, either select them in the menu on the left of this page, or click on one of the annotations in this complete example: diff --git a/docs/website/docs/features/parameterize.md b/docs/website/docs/features/parameterize.md index eed6c2f..5a36625 100644 --- a/docs/website/docs/features/parameterize.md +++ b/docs/website/docs/features/parameterize.md @@ -1,4 +1,4 @@ -# Parameterized tests +# Declare parameterized tests in Kotlin When we want to test edge cases or invariants, it is common to execute the same test, but with different data. For the sake of this example, let's say we want to test a function that checks whether a number is odd: ```kotlin diff --git a/docs/website/docs/features/prepared-values.md b/docs/website/docs/features/prepared-values.md index 6a6ad85..21eec78 100644 --- a/docs/website/docs/features/prepared-values.md +++ b/docs/website/docs/features/prepared-values.md @@ -1,4 +1,4 @@ -# Prepared • Isolated fixtures +# Use lazy fixtures in your Kotlin tests Prepared values are the flagship feature of OpenSavvy Prepared. diff --git a/docs/website/docs/features/random.md b/docs/website/docs/features/random.md index dc94cc4..374a55b 100644 --- a/docs/website/docs/features/random.md +++ b/docs/website/docs/features/random.md @@ -1,4 +1,4 @@ -# Randomness +# Control randomness in your Kotlin tests Randomness can be useful to generate arbitrary test data (e.g. for fuzzing, property testing, generating default values…). However, tests that exhibit randomness are quickly hard to debug: re-running them may give a different result! diff --git a/docs/website/docs/features/shared-values.md b/docs/website/docs/features/shared-values.md index 093b65c..19560da 100644 --- a/docs/website/docs/features/shared-values.md +++ b/docs/website/docs/features/shared-values.md @@ -1,4 +1,4 @@ -# Shared • Classic fixtures +# Use shared fixtures in your Kotlin tests Pure, immutable values generated once for the entire test suite. diff --git a/docs/website/docs/features/time.md b/docs/website/docs/features/time.md index 25d2787..95cbe8b 100644 --- a/docs/website/docs/features/time.md +++ b/docs/website/docs/features/time.md @@ -1,4 +1,4 @@ -# Date and time +# Control the flow of time in your Kotlin tests Tests run in virtual time: a fixed timescale which is controlled by the developer. diff --git a/docs/website/docs/tutorials/index.md b/docs/website/docs/tutorials/index.md index 26c1337..ab2736d 100644 --- a/docs/website/docs/tutorials/index.md +++ b/docs/website/docs/tutorials/index.md @@ -1,4 +1,4 @@ -# Getting started +# Getting started with the Prepared test DSL Test frameworks are split into multiple tools: diff --git a/docs/website/docs/tutorials/syntax.md b/docs/website/docs/tutorials/syntax.md index 68fbf59..b98bed4 100644 --- a/docs/website/docs/tutorials/syntax.md +++ b/docs/website/docs/tutorials/syntax.md @@ -1,4 +1,4 @@ -# Suites and tests +# Declaring suites and tests Prepared aims to simplify the way tests are declared. Where traditional frameworks require verbose annotation-based logic, Prepared takes advantage of Kotlin's concise syntax to remove most magic. diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 4cade1b..67a1ee2 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -111,20 +111,20 @@ nav: - Getting started: - tutorials/index.md - - tutorials/syntax.md + - Suites and tests: tutorials/syntax.md - Features: - features/index.md - - features/prepared-values.md - - features/shared-values.md - - features/finalizers.md - - features/async.md - - features/parameterize.md + - Prepared • Isolated fixtures: features/prepared-values.md + - Shared • Classic fixtures: features/shared-values.md + - Finalizers: features/finalizers.md + - Asynchronous operations: features/async.md + - Parameterized tests: features/parameterize.md - Controlling external data: - - features/time.md - - features/random.md - - features/files.md + - Date and time: features/time.md + - Randomness: features/random.md + - Files: features/files.md - Integrations: - Ktor: features/compat-ktor.md