From d40563ea9fabe891f14bbced9f749977a415b771 Mon Sep 17 00:00:00 2001
From: Valentin Gagarin <valentin@gagarin.work>
Date: Wed, 15 May 2024 18:37:05 +0200
Subject: [PATCH 1/2] add Vale for prose linting

---
 formatter.nix | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/formatter.nix b/formatter.nix
index 12853b5a4..1bd494ca6 100644
--- a/formatter.nix
+++ b/formatter.nix
@@ -45,5 +45,55 @@
         ];
         includes = [ "*.py" ];
       };
+      treefmt.settings.formatter.vale =
+        with pkgs;
+        let
+          vocab = "cLAN";
+          style = "Docs";
+          config = writeText "vale.ini" ''
+            StylesPath = ${styles}
+            Vocab = ${vocab}
+
+            [*.md]
+            BasedOnStyles = Vale, ${style}
+            Vale.Terms = No
+          '';
+          styles = symlinkJoin {
+            name = "vale-style";
+            paths = [
+              accept
+              headings
+            ];
+          };
+          accept = writeTextDir "config/vocabularies/${vocab}/accept.txt" ''
+            cLAN
+            Nix
+            NixOS
+            Nixpkgs
+            clan.lol
+            Clan
+            monorepo
+          '';
+          headings = writeTextDir "${style}/headings.yml" ''
+            extends: capitalization
+            message: "'%s' should be in sentence case"
+            level: error
+            scope: heading
+            # $title, $sentence, $lower, $upper, or a pattern.
+            match: $sentence
+          '';
+        in
+        {
+          command = "${vale}/bin/vale";
+          options = [ "--config=${config}" ];
+          includes = [ "*.md" ];
+          # TODO: too much at once, fix piecemeal
+          excludes = [
+            "README.md"
+            "docs/*"
+            "clanModules/*"
+            "pkgs/*"
+          ];
+        };
     };
 }

From fca586ff21207a010d9d887ad66b66bed65bc7ea Mon Sep 17 00:00:00 2001
From: Valentin Gagarin <valentin@gagarin.work>
Date: Wed, 22 May 2024 13:10:54 +0200
Subject: [PATCH 2/2] fix spelling in README

---
 README.md     | 12 ++++++------
 formatter.nix |  2 --
 2 files changed, 6 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 777aba209..8fe480c7e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Clan Core Repository
+# Clan core repository
 
-Welcome to the Clan Core Repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the Clan project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.
+Welcome to the Clan core repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the Clan project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.
 
 ## Why Clan?
 
@@ -14,13 +14,13 @@ Our mission is simple: to democratize computing by providing tools that empower
 - **Robust Backup Management:** Long-term, self-hosted data preservation.
 - **Intuitive Secret Management:** Simplified encryption and password management processes.
 
-## Getting Started with Clan
+## Getting started with Clan
 
 If you're new to Clan and eager to dive in, start with our quickstart guide and explore the core functionalities that Clan offers:
 
 - **Quickstart Guide**: Check out [getting started](https://docs.clan.lol/#starting-with-a-new-clan-project)<!-- [docs/site/index.md](docs/site/index.md) --> to get up and running with Clan in no time.
 
-### Managing Secrets
+### Managing secrets
 
 In the Clan ecosystem, security is paramount. Learn how to handle secrets effectively:
 
@@ -32,11 +32,11 @@ The Clan project thrives on community contributions. We welcome everyone to cont
 
 - **Contribution Guidelines**: Make a meaningful impact by following the steps in [contributing](https://docs.clan.lol/contributing/contributing/)<!-- [contributing.md](docs/CONTRIBUTING.md) -->.
 
-## Join the Revolution
+## Join the revolution
 
 Clan is more than a tool; it's a movement towards a better digital future. By contributing to the Clan project, you're part of changing technology for the better, together.
 
-### Community and Support
+### Community and support
 
 Connect with us and the Clan community for support and discussion:
 
diff --git a/formatter.nix b/formatter.nix
index 1bd494ca6..945aa3846 100644
--- a/formatter.nix
+++ b/formatter.nix
@@ -66,7 +66,6 @@
             ];
           };
           accept = writeTextDir "config/vocabularies/${vocab}/accept.txt" ''
-            cLAN
             Nix
             NixOS
             Nixpkgs
@@ -89,7 +88,6 @@
           includes = [ "*.md" ];
           # TODO: too much at once, fix piecemeal
           excludes = [
-            "README.md"
             "docs/*"
             "clanModules/*"
             "pkgs/*"