Skip to content

Commit 9264f63

Browse files
committed
Clean up index headers
1 parent c298cea commit 9264f63

File tree

10 files changed

+14
-14
lines changed

10 files changed

+14
-14
lines changed

docs/datatypes/writer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ type Writer[L, V] = WriterT[Id, L, V]
125125

126126
So, all the [Operations](#operations) defined in the previous section
127127
are actually coming from the [WriterT
128-
datatype](writert.md)
128+
datatype](../monadtransformers/writert.md)
129129

130-
Most of the [`WriterT`](writert.md) functions require a
130+
Most of the [`WriterT`](../monadtransformers/writert.md) functions require a
131131
[`Functor[F]`](../typeclasses/functor.md) or
132132
[`Monad[F]`](../typeclasses/monad.md)
133133
instance. However, Cats provides all the necessary instances for the

docs/guidelines.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ abstract class KleisliInstance1 {
109109
We can introduce new type classes for the sake of adding laws that don't apply to the parent type class, e.g. `CommutativeSemigroup` and
110110
`CommutativeArrow`.
111111

112-
### Applicative instances for monad transformers</a>
112+
### Applicative instances for monad transformers
113113

114114
We explicitly don't provide an instance of `Applicative` for e.g. `EitherT[F, String, *]` given an `Applicative[F]`.
115115
An attempt to construct one without a proper `Monad[F]` instance would be inconsistent in `ap` with the provided `Monad` instance

docs/imports.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import cats.data._
88
import cats.syntax.all._
99
```
1010

11-
The `cats._` import brings in quite a few [type classes](typeclasses.md) (similar to interfaces) such as [Monad](typeclasses/monad.md), [Semigroup](typeclasses/semigroup.md), and [Foldable](typeclasses/foldable.md). Instead of the entire `cats` package, you can import only the types that you need, for example:
11+
The `cats._` import brings in quite a few [type classes](typeclasses/index.md) (similar to interfaces) such as [Monad](typeclasses/monad.md), [Semigroup](typeclasses/semigroup.md), and [Foldable](typeclasses/foldable.md). Instead of the entire `cats` package, you can import only the types that you need, for example:
1212

1313
```scala mdoc:reset:silent
1414
import cats.Monad

docs/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ We thankfully accept <a href="https://opencollective.com/typelevel/donate">one-t
6565

6666
<script src="/cats/js/sponsors.js"></script>
6767

68-
### Getting Started
68+
## Getting Started
6969

7070
Cats is available for [Scala.js](http://www.scala-js.org/) and [Scala Native](https://www.scala-native.org/), as well as the standard JVM runtime.
7171

@@ -130,7 +130,7 @@ into larger problems.
130130
If you are being harassed, please contact one of [us](#maintainers)
131131
immediately so that we can support you.
132132

133-
### Binary compatibility and versioning
133+
## Binary Compatibility and Versioning
134134

135135
After `1.0.0` release, we [decided](https://github.com/typelevel/cats/issues/1233)
136136
to use *MAJOR.MINOR.PATCH* [Semantic Versioning 2.0.0](http://semver.org/)
@@ -157,11 +157,11 @@ Any binary breaking changes will require a *MAJOR* version bump, which we will b
157157
cautious about. We will also consider using `organization` and package name for major
158158
versioning in the future. But that decision is yet to be made.
159159

160-
### Adopters
160+
## Adopters
161161

162162
A (non-exhaustive) list of companies that use Cats in production is featured on the [Adopters page]. Don't see yours? [You can add it in a PR!](https://github.com/typelevel/cats/edit/main/ADOPTERS.md) And if you can, consider [supporting us](https://opencollective.com/typelevel).
163163

164-
### Maintainers
164+
## Maintainers
165165

166166
The current maintainers (people who can merge pull requests) are:
167167

@@ -194,7 +194,7 @@ wait for more). For typos, documentation improvements or minor build fix we
194194
relax this to a single sign-off. More detail in the [process document](https://github.com/typelevel/cats/blob/main/PROCESS.md).
195195

196196

197-
### Copyright and License
197+
## Copyright and License
198198

199199
All code is available to you under the MIT license, available at
200200
http://opensource.org/licenses/mit-license.php and also in the

docs/monadtransformers/directory.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
laika.title = Monad Transformers
22
laika.navigationOrder = [
3-
monadtransformers.md
3+
index.md
44
contt.md
55
eithert.md
66
iort.md

docs/monadtransformers/monadtransformers.md docs/monadtransformers/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ If any of the checks fails, the resulting `EitherT` will contain a `Left` value.
202202
Otherwise, if all of the checks yield a `Right` (of course we mean a `Right` wrapped into an `EitherT`), then the final outcome will also contain `Right`.
203203
This is a fail-fast behavior: we're effectively stopping the `for` comprehension flow at the first `Left`-ish result.
204204

205-
If you're instead looking for validation that accumulates the errors (e.g. when dealing with user-provided form data), [Validated](datatypes/validated.md) or the [Parallel](typeclasses/parallel.md) applicative functor for `Either` may be a good choice.
205+
If you're instead looking for validation that accumulates the errors (e.g. when dealing with user-provided form data), [Validated](../datatypes/validated.md) or the [Parallel](../typeclasses/parallel.md) applicative functor for `Either` may be a good choice.
206206

207207
## Pitfalls
208208

docs/motivations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ page](CONTRIBUTING.md) to find out ways to give us feedback.
1515
#### Modularity
1616

1717
We are trying to make the library modular. It will have a tight
18-
core which will contain only the [type classes](typeclasses.md),
18+
core which will contain only the [type classes](typeclasses/index.md),
1919
the bare minimum of data structures that are needed to support
2020
them, and type class instances for those data structures and standard
2121
library types.

docs/typeclasses/directory.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
laika.title = Type Classes
22
laika.navigationOrder = [
3-
typeclasses.md
3+
index.md
44
alternative.md
55
applicative.md
66
applicativemonaderror.md
File renamed without changes.

docs/typeclasses/lawtesting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Law testing
22

3-
[Laws](../typeclasses.md#laws) are an important part of cats.
3+
[Laws](../typeclasses/index.md#laws) are an important part of cats.
44
Cats uses [discipline](https://github.com/typelevel/discipline) to define type class laws and
55
the [ScalaCheck](https://github.com/rickynils/scalacheck) tests based on them.
66

0 commit comments

Comments
 (0)