Skip to content

Commit 4774dbc

Browse files
committed
[ docs ] Change name of tutorials to make compatible with Idris2 module names
1 parent 4523881 commit 4774dbc

14 files changed

Lines changed: 71 additions & 71 deletions

docs/source/tutorials.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ You can read more in the `original framework <https://diataxis.fr/tutorials/>`_
1515
:caption: Choose what to learn
1616

1717
tutorials/index
18-
tutorials/00-installation-and-setup
19-
tutorials/01-generator-monad
20-
tutorials/02-handling-emptiness
21-
tutorials/03-measuring-test-coverage
22-
tutorials/04-automatic-generator-derivation
23-
tutorials/05-derivegen-signatures
24-
tutorials/06-beyond-fuel
25-
tutorials/07-derivation-tuning
26-
tutorials/08-under-the-hood-a-derivegen-like-macro
27-
tutorials/09-mixing-manual-and-automatic
28-
tutorials/10-generating-gadts-with-proofs
29-
tutorials/11-real-world-example
18+
tutorials/t00-installation-and-setup
19+
tutorials/t01-generator-monad
20+
tutorials/t02-handling-emptiness
21+
tutorials/t03-measuring-test-coverage
22+
tutorials/t04-automatic-generator-derivation
23+
tutorials/t05-derivegen-signatures
24+
tutorials/t06-beyond-fuel
25+
tutorials/t07-derivation-tuning
26+
tutorials/t08-under-the-hood-a-derivegen-like-macro
27+
tutorials/t09-mixing-manual-and-automatic
28+
tutorials/t10-generating-gadts-with-proofs
29+
tutorials/t11-real-world-example

docs/source/tutorials/index.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Everyone should complete this track to master DepTyCheck fundamentals.
1616

1717
| # | Tutorial |
1818
|---|----------|
19-
| 0 | [Installation and First Steps](00-installation-and-setup.md) |
20-
| 1 | [The Generator Monad](01-generator-monad.md) |
21-
| 2 | [Handling Emptiness](02-handling-emptiness.md) |
22-
| 3 | [Measuring Coverage](03-measuring-test-coverage.md) |
23-
| 4 | [Automatic Derivation](04-automatic-generator-derivation.md) |
24-
| 5 | [DeriveGen Signatures](05-derivegen-signatures.md) |
25-
| 6 | [Beyond Fuel](06-beyond-fuel.md) |
19+
| 0 | [Installation and First Steps](t00-installation-and-setup.md) |
20+
| 1 | [The Generator Monad](t01-generator-monad.md) |
21+
| 2 | [Handling Emptiness](t02-handling-emptiness.md) |
22+
| 3 | [Measuring Coverage](t03-measuring-test-coverage.md) |
23+
| 4 | [Automatic Derivation](t04-automatic-generator-derivation.md) |
24+
| 5 | [DeriveGen Signatures](t05-derivegen-signatures.md) |
25+
| 6 | [Beyond Fuel](t06-beyond-fuel.md) |
2626

2727
**Prerequisites:** Basic Idris 2 knowledge (data types, functions, REPL)
2828

@@ -34,11 +34,11 @@ Continue here after completing the Core Track.
3434

3535
| # | Tutorial |
3636
|---|----------|
37-
| 7 | [Derivation Tuning](07-derivation-tuning.md) |
38-
| 8 | [Under the Hood](08-under-the-hood-a-derivegen-like-macro.md) |
39-
| 9 | [Mixing Manual and Automatic](09-mixing-manual-and-automatic.md) |
40-
| 10 | [Generating GADTs with Proofs](10-generating-gadts-with-proofs.md) |
41-
| 11 | [Real-World Example: DSL ASTs](11-real-world-example.md) |
37+
| 7 | [Derivation Tuning](t07-derivation-tuning.md) |
38+
| 8 | [Under the Hood](t08-under-the-hood-a-derivegen-like-macro.md) |
39+
| 9 | [Mixing Manual and Automatic](t09-mixing-manual-and-automatic.md) |
40+
| 10 | [Generating GADTs with Proofs](t10-generating-gadts-with-proofs.md) |
41+
| 11 | [Real-World Example: DSL ASTs](t11-real-world-example.md) |
4242

4343
**Prerequisites:** Core Track completion
4444

@@ -50,18 +50,18 @@ Continue here after completing the Core Track.
5050

5151
| | |
5252
|------|------------|
53-
| Install DepTyCheck | [Tutorial 0](00-installation-and-setup.md) |
54-
| Generate simple data types | [Tutorial 1](01-generator-monad.md) |
55-
| Handle types that might be empty | [Tutorial 2](02-handling-emptiness.md) |
56-
| Check if my generators are biased | [Tutorial 3](03-measuring-test-coverage.md) |
57-
| Stop writing generators by hand | [Tutorial 4](04-automatic-generator-derivation.md) |
58-
| Control what deriveGen generates | [Tutorial 5](05-derivegen-signatures.md) |
59-
| Understand recursion performance | [Tutorial 6](06-beyond-fuel.md) |
60-
| Fix biased automatic generators | [Tutorial 7](07-derivation-tuning.md) |
61-
| Build custom derivation strategies | [Tutorial 8](08-under-the-hood-a-derivegen-like-macro.md) |
62-
| Use my custom generators with deriveGen | [Tutorial 9](09-mixing-manual-and-automatic.md) |
63-
| Generate types with proof arguments | [Tutorial 10](10-generating-gadts-with-proofs.md) |
64-
| Generate complete programs for a DSL | [Tutorial 11](11-real-world-example.md) |
53+
| Install DepTyCheck | [Tutorial 0](t00-installation-and-setup.md) |
54+
| Generate simple data types | [Tutorial 1](t01-generator-monad.md) |
55+
| Handle types that might be empty | [Tutorial 2](t02-handling-emptiness.md) |
56+
| Check if my generators are biased | [Tutorial 3](t03-measuring-test-coverage.md) |
57+
| Stop writing generators by hand | [Tutorial 4](t04-automatic-generator-derivation.md) |
58+
| Control what deriveGen generates | [Tutorial 5](t05-derivegen-signatures.md) |
59+
| Understand recursion performance | [Tutorial 6](t06-beyond-fuel.md) |
60+
| Fix biased automatic generators | [Tutorial 7](t07-derivation-tuning.md) |
61+
| Build custom derivation strategies | [Tutorial 8](t08-under-the-hood-a-derivegen-like-macro.md) |
62+
| Use my custom generators with deriveGen | [Tutorial 9](t09-mixing-manual-and-automatic.md) |
63+
| Generate types with proof arguments | [Tutorial 10](t10-generating-gadts-with-proofs.md) |
64+
| Generate complete programs for a DSL | [Tutorial 11](t11-real-world-example.md) |
6565

6666
---
6767

docs/source/tutorials/00-installation-and-setup.md renamed to docs/source/tutorials/t00-installation-and-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,4 +195,4 @@ Green : TrafficLight
195195

196196
Now that you have a working setup, you are ready to learn the fundamentals of generator creation:
197197

198-
* **Continue to Tutorial 1:** [The Generator Monad](01-generator-monad.md) to learn how to create generators manually using `pure`, `elements`, `choose`, and other combinators.
198+
* **Continue to Tutorial 1:** [The Generator Monad](t01-generator-monad.md) to learn how to create generators manually using `pure`, `elements`, `choose`, and other combinators.

docs/source/tutorials/01-generator-monad.md renamed to docs/source/tutorials/t01-generator-monad.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ MkProfile "Alice" 37 : UserProfile
2020

2121
## Prerequisites
2222

23-
This tutorial assumes you have completed [Installation and First Steps](00-installation-and-setup.md) and have a working Idris 2 installation with DepTyCheck configured.
23+
This tutorial assumes you have completed [Installation and First Steps](t00-installation-and-setup.md) and have a working Idris 2 installation with DepTyCheck configured.
2424

2525
---
2626

@@ -225,5 +225,5 @@ Finally, let's generate a list of test users. You can use the `listOf` combinato
225225
226226
You've mastered the basics. Where you go next depends on your needs:
227227
228-
* **Want to handle types that might be empty?** Continue to [Handling Emptiness](02-handling-emptiness.md) to learn about `Gen0`, `empty`, and `pick`.
229-
* **Ready to have `DepTyCheck` do the work for you?** Continue to [Automatic Generator Derivation](04-automatic-generator-derivation.md) to learn about `deriveGen`.
228+
* **Want to handle types that might be empty?** Continue to [Handling Emptiness](t02-handling-emptiness.md) to learn about `Gen0`, `empty`, and `pick`.
229+
* **Ready to have `DepTyCheck` do the work for you?** Continue to [Automatic Generator Derivation](t04-automatic-generator-derivation.md) to learn about `deriveGen`.

docs/source/tutorials/02-handling-emptiness.md renamed to docs/source/tutorials/t02-handling-emptiness.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 2. Handling Emptiness: When a Type Has No Values
22

3-
In the [first tutorial](01-generator-monad.md), we used `Gen1`, which is a guarantee—a promise—that a value can always be generated. This works perfectly for types like `Nat` or `String` that always have inhabitants.
3+
In the [first tutorial](t01-generator-monad.md), we used `Gen1`, which is a guarantee—a promise—that a value can always be generated. This works perfectly for types like `Nat` or `String` that always have inhabitants.
44

55
But what happens when a type might be **uninhabited** (have no values at all) under certain conditions?
66

@@ -28,7 +28,7 @@ Nothing : Maybe (Fin 0)
2828

2929
## Prerequisites
3030

31-
This tutorial assumes you have completed [Installation and First Steps](00-installation-and-setup.md) and the first tutorial, ["The Generator Monad"](01-generator-monad.md).
31+
This tutorial assumes you have completed [Installation and First Steps](t00-installation-and-setup.md) and the first tutorial, ["The Generator Monad"](t01-generator-monad.md).
3232

3333
---
3434

@@ -163,4 +163,4 @@ This demonstrates another critical aspect of `Gen0`: it allows for speculative g
163163
164164
Now that you've mastered manual generation for both simple and complex types, it's time to see how `DepTyCheck` can do this work for you automatically.
165165
166-
* **Next Tutorial:** Continue to **[Measuring Your Test Coverage](03-measuring-test-coverage.md)** to learn how to analyze the quality of your generated data.
166+
* **Next Tutorial:** Continue to **[Measuring Your Test Coverage](t03-measuring-test-coverage.md)** to learn how to analyze the quality of your generated data.

docs/source/tutorials/03-measuring-test-coverage.md renamed to docs/source/tutorials/t03-measuring-test-coverage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ TrafficLight covered fully (1000 times)
1717

1818
## Prerequisites
1919

20-
This tutorial assumes you have completed [Installation and First Steps](00-installation-and-setup.md) and the first two tutorials on [basic generation](01-generator-monad.md) and [emptiness handling](02-handling-emptiness.md).
20+
This tutorial assumes you have completed [Installation and First Steps](t00-installation-and-setup.md) and the first two tutorials on [basic generation](t01-generator-monad.md) and [emptiness handling](t02-handling-emptiness.md).
2121

2222
---
2323

@@ -163,4 +163,4 @@ Besides aggregated reports, labels are also an invaluable tool for debugging. Yo
163163
164164
Now that you can write, run, and measure generators manually, it's time to learn how `DepTyCheck` can do all of this for you automatically.
165165
166-
* **Next Tutorial:** Continue to **[Automatic Generator Derivation](04-automatic-generator-derivation.md)** to learn how to use `deriveGen`.
166+
* **Next Tutorial:** Continue to **[Automatic Generator Derivation](t04-automatic-generator-derivation.md)** to learn how to use `deriveGen`.

docs/source/tutorials/04-automatic-generator-derivation.md renamed to docs/source/tutorials/t04-automatic-generator-derivation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ In this tutorial, we will use a single, running example—a file system `Entry`
1515

1616
## Prerequisites
1717

18-
- Completion of [Installation and First Steps](00-installation-and-setup.md) and the tutorials on [manual generation](01-generator-monad.md), [emptiness](02-handling-emptiness.md), and [coverage analysis](03-measuring-test-coverage.md).
18+
- Completion of [Installation and First Steps](t00-installation-and-setup.md) and the tutorials on [manual generation](t01-generator-monad.md), [emptiness](t02-handling-emptiness.md), and [coverage analysis](t03-measuring-test-coverage.md).
1919

2020
---
2121

@@ -187,6 +187,6 @@ This powerful pattern allows you to create highly flexible generators that adapt
187187
188188
Now that you know how to automatically generate data and provide hints, you are ready for more advanced topics:
189189
190-
* **Want to learn how to control what gets generated?** Continue to **[DeriveGen Signatures](05-derivegen-signatures.md)** to learn how to use given vs generated parameters and dependent pairs in signatures.
191-
* **Want to understand how recursion affects generation?** Continue to **[Beyond Fuel](06-beyond-fuel.md)** to learn about `SpendingFuel` vs `StructurallyDecreasing` recursion.
192-
* **How do I fix a biased generator or control generation order?** The default derivation strategy is smart, but sometimes needs more specific guidance. Continue to **[Derivation Tuning](07-derivation-tuning.md)** to learn how to use `instance` declarations to control constructor probabilities and argument generation order.
190+
* **Want to learn how to control what gets generated?** Continue to **[DeriveGen Signatures](t05-derivegen-signatures.md)** to learn how to use given vs generated parameters and dependent pairs in signatures.
191+
* **Want to understand how recursion affects generation?** Continue to **[Beyond Fuel](t06-beyond-fuel.md)** to learn about `SpendingFuel` vs `StructurallyDecreasing` recursion.
192+
* **How do I fix a biased generator or control generation order?** The default derivation strategy is smart, but sometimes needs more specific guidance. Continue to **[Derivation Tuning](t07-derivation-tuning.md)** to learn how to use `instance` declarations to control constructor probabilities and argument generation order.

docs/source/tutorials/05-derivegen-signatures.md renamed to docs/source/tutorials/t05-derivegen-signatures.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This will give you a deep understanding of how to use signatures to control `der
1616

1717
## Prerequisites
1818

19-
- All previous tutorials, especially [Measuring Your Test Coverage](03-measuring-test-coverage.md).
19+
- All previous tutorials, especially [Measuring Your Test Coverage](t03-measuring-test-coverage.md).
2020

2121
---
2222

@@ -154,5 +154,5 @@ Let's combine the patterns we've learned. Our final generator will be the most f
154154
155155
Now that you know how to control `deriveGen` through signatures, you are ready for more advanced topics:
156156
157-
* **Want to understand how recursion affects generation?** Continue to **[Beyond Fuel: Structural Recursion](06-beyond-fuel.md)** to learn about `SpendingFuel` vs `StructurallyDecreasing` recursion.
158-
* **Want to generate types with proof constraints?** Continue to **[Generating GADTs with Proofs](10-generating-gadts-with-proofs.md)** to see how `deriveGen` handles types like `SortedList`.
157+
* **Want to understand how recursion affects generation?** Continue to **[Beyond Fuel: Structural Recursion](t06-beyond-fuel.md)** to learn about `SpendingFuel` vs `StructurallyDecreasing` recursion.
158+
* **Want to generate types with proof constraints?** Continue to **[Generating GADTs with Proofs](t10-generating-gadts-with-proofs.md)** to see how `deriveGen` handles types like `SortedList`.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You will learn why this happens, how to recognize the difference between **`Spen
1515

1616
## Prerequisites
1717

18-
- All previous tutorials, especially [Automatic Generator Derivation](04-automatic-generator-derivation.md).
18+
- All previous tutorials, especially [Automatic Generator Derivation](t04-automatic-generator-derivation.md).
1919

2020
---
2121

@@ -191,6 +191,6 @@ This is the core optimization: when the type system guarantees termination throu
191191

192192
Now that you understand how `deriveGen` handles recursion, you are ready for more advanced topics:
193193

194-
* **Want to fix biased generators?** Continue to **[Derivation Tuning](07-derivation-tuning.md)** to learn how to use `ProbabilityTuning` and `GenOrderTuning` instances.
195-
* **Want to integrate handwritten generators?** Continue to **[Mixing Manual and Automatic Generation](09-mixing-manual-and-automatic.md)** to see how `deriveGen` discovers and uses your custom generators.
196-
* **Want to generate types with proof constraints?** Continue to **[Generating GADTs with Proofs](10-generating-gadts-with-proofs.md)** to see how `deriveGen` handles auto-implicit proof arguments.
194+
* **Want to fix biased generators?** Continue to **[Derivation Tuning](t07-derivation-tuning.md)** to learn how to use `ProbabilityTuning` and `GenOrderTuning` instances.
195+
* **Want to integrate handwritten generators?** Continue to **[Mixing Manual and Automatic Generation](t09-mixing-manual-and-automatic.md)** to see how `deriveGen` discovers and uses your custom generators.
196+
* **Want to generate types with proof constraints?** Continue to **[Generating GADTs with Proofs](t10-generating-gadts-with-proofs.md)** to see how `deriveGen` handles auto-implicit proof arguments.

docs/source/tutorials/07-derivation-tuning.md renamed to docs/source/tutorials/t07-derivation-tuning.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ We will tackle two common problems that cannot be solved with external generator
1313

1414
## Prerequisites
1515

16-
- Completion of [Automatic Generator Derivation](04-automatic-generator-derivation.md).
16+
- Completion of [Automatic Generator Derivation](t04-automatic-generator-derivation.md).
1717
- A willingness to engage with some advanced Idris concepts!
1818

1919
---
@@ -145,7 +145,7 @@ data LtPair : Type where
145145
146146
## Next Steps
147147
148-
* **Want to integrate handwritten generators?** Continue to **[Mixing Manual and Automatic Generation](09-mixing-manual-and-automatic.md)** to see how `deriveGen` automatically discovers and uses your custom generators.
149-
* **Want to generate types with proof constraints?** Continue to **[Generating GADTs with Proofs](10-generating-gadts-with-proofs.md)** to see how `deriveGen` handles GADTs with auto-implicit proof arguments.
150-
* **Want to see a real-world example?** Continue to **[Real-World Example: Generating ASTs for a DSL](11-real-world-example.md)** to build a complete generator for a simple imperative language.
151-
* **Want to understand the internals?** Continue to **[Under the Hood: Building a deriveGen-like Macro](08-under-the-hood-a-derivegen-like-macro.md)** to learn how the derivation engine works.
148+
* **Want to integrate handwritten generators?** Continue to **[Mixing Manual and Automatic Generation](t09-mixing-manual-and-automatic.md)** to see how `deriveGen` automatically discovers and uses your custom generators.
149+
* **Want to generate types with proof constraints?** Continue to **[Generating GADTs with Proofs](t10-generating-gadts-with-proofs.md)** to see how `deriveGen` handles GADTs with auto-implicit proof arguments.
150+
* **Want to see a real-world example?** Continue to **[Real-World Example: Generating ASTs for a DSL](t11-real-world-example.md)** to build a complete generator for a simple imperative language.
151+
* **Want to understand the internals?** Continue to **[Under the Hood: Building a deriveGen-like Macro](t08-under-the-hood-a-derivegen-like-macro.md)** to learn how the derivation engine works.

0 commit comments

Comments
 (0)