From eb84fc513b015ed5d2d2c03e339ddb50c186e4ac Mon Sep 17 00:00:00 2001
From: Rob van der Leek <5324924+robvanderleek@users.noreply.github.com>
Date: Tue, 10 Dec 2024 11:41:56 +0100
Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20Small=20changes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/index.md | 17 +++++++++++++----
mkdocs.yml | 2 +-
2 files changed, 14 insertions(+), 5 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index ca7e22e..2c6f491 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,3 +1,7 @@
+
+
@@ -40,11 +44,16 @@ it’s time to refactor_.
* **A non-controversial code metric**: Most developers agree longer functions
are harder to maintain
* **Actionable results**: There's always a refactoring possible to make
- functions smaller.
-* **Runs everywhere**: Fits your development workflow, whether it's in a build
- pipeline, a pre-commit hook, or standalone.
+ functions smaller
+* **Runs everywhere**: Fits your development workflow, whether it's in a [build
+ pipeline](getting-started/development-workflow.md), a [pre-commit
+hook](getting-started/development-workflow.md#pre-commit-hook), or
+[standalone](getting-started/standalone-usage.md)
* **Covers many languages**: A single tool for all your projects
-* **Sane defaults**: Zero configuration, but allows customization.
+* **Sane defaults**: Zero configuration, but allows customization
+* **Low threshold to get started**: Can only check new or modified code, so
+ even if you have a backlog of technical debt, you can start using Code Limit
+today
*[functions]: Also called methods or procedures, depending on your programming language
diff --git a/mkdocs.yml b/mkdocs.yml
index 11762e7..cab5b94 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -37,7 +37,7 @@ markdown_extensions:
- attr_list
- pymdownx.snippets
nav:
- - 'index.md'
+ - Code Limit: 'index.md'
- 'why-function-length.md'
- Getting Started:
- 'getting-started/development-workflow.md'
