From bf1d49868ec59015bd0bc44a70c51a0effd583f1 Mon Sep 17 00:00:00 2001 From: Katrix Date: Sun, 3 Mar 2024 18:17:37 +0100 Subject: [PATCH] Fix docs a bit --- .../{typeclasses.md => guide/01_typeclasses.md} | 0 .../{hkdgeneric.md => guide/02_hkdgeneric.md} | 2 +- .../03_inlinehkdgeneric.md} | 0 .../04_exprhkdgeneric.md} | 2 +- docs/sidebar.yml | 16 ++++++++-------- 5 files changed, 10 insertions(+), 10 deletions(-) rename docs/_docs/{typeclasses.md => guide/01_typeclasses.md} (100%) rename docs/_docs/{hkdgeneric.md => guide/02_hkdgeneric.md} (98%) rename docs/_docs/{inlinehkdgeneric.md => guide/03_inlinehkdgeneric.md} (100%) rename docs/_docs/{exprhkdgeneric.md => guide/04_exprhkdgeneric.md} (99%) diff --git a/docs/_docs/typeclasses.md b/docs/_docs/guide/01_typeclasses.md similarity index 100% rename from docs/_docs/typeclasses.md rename to docs/_docs/guide/01_typeclasses.md diff --git a/docs/_docs/hkdgeneric.md b/docs/_docs/guide/02_hkdgeneric.md similarity index 98% rename from docs/_docs/hkdgeneric.md rename to docs/_docs/guide/02_hkdgeneric.md index 8986140..b40bfd6 100644 --- a/docs/_docs/hkdgeneric.md +++ b/docs/_docs/guide/02_hkdgeneric.md @@ -9,7 +9,7 @@ data type `Gen`. These functions are `def to(a: A): Gen[Id]` and `def from(gen: type `Gen` can be manipulated and changed in the same way as a `List` can be changed. Functions providing these operations are exposed on higher kinded versions of typical typeclasses like `Functor`, `Applicative`, `Traverse` and so on. More details on these operations and typeclases can -be found in [typeclasses](typeclasses.md). Of particular note is `Representable` +be found in [typeclasses](01_typeclasses.md). Of particular note is `Representable` ## "Fused" `RepresentableK` operations diff --git a/docs/_docs/inlinehkdgeneric.md b/docs/_docs/guide/03_inlinehkdgeneric.md similarity index 100% rename from docs/_docs/inlinehkdgeneric.md rename to docs/_docs/guide/03_inlinehkdgeneric.md diff --git a/docs/_docs/exprhkdgeneric.md b/docs/_docs/guide/04_exprhkdgeneric.md similarity index 99% rename from docs/_docs/exprhkdgeneric.md rename to docs/_docs/guide/04_exprhkdgeneric.md index ff120ea..eb85a26 100644 --- a/docs/_docs/exprhkdgeneric.md +++ b/docs/_docs/guide/04_exprhkdgeneric.md @@ -1,5 +1,5 @@ --- -title: HKDGeneric +title: ExprHKDGeneric --- # {{page.title}} diff --git a/docs/sidebar.yml b/docs/sidebar.yml index 0f13490..ff0044b 100644 --- a/docs/sidebar.yml +++ b/docs/sidebar.yml @@ -1,13 +1,13 @@ index: index.md subsection: - - title: Typeclasses - page: typeclasses.md + - page: guide/01_typeclasses.md + directory: Guide - - title: HKDGeneric - page: hkdgeneric.md + - page: guide/02_hkdgeneric.md + directory: Guide - - title: InlineHKDGeneric - page: inlinehkdgeneric.md + - page: guide/03_inlinehkdgeneric.md + directory: Guide - - title: ExprHKDGeneric - page: exprhkdgeneric.md \ No newline at end of file + - page: guide/04_exprhkdgeneric.md + directory: Guide \ No newline at end of file