Merge pull request #5 from danfimov/fix-docs

Author: danfimov

README.md

@@ -2,7 +2,7 @@
 
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-knobs?style=for-the-badge&logo=python)](https://pypi.org/project/django-knobs/)
 [![PyPI](https://img.shields.io/pypi/v/django-knobs?style=for-the-badge&logo=pypi)](https://pypi.org/project/django-knobs/)
-[![Checks](https://img.shields.io/github/check-runs/danfimov/django-knobs/main?nameFilter=Tests%20(3.12)&style=for-the-badge)](https://github.com/danfimov/django-knobs)
+[![Checks](https://img.shields.io/github/actions/workflow/status/danfimov/django-knobs/code-check.yml?branch=main&style=for-the-badge)](https://github.com/danfimov/django-knobs)
 
 Library for dynamic settings / feature flags that can be changed at runtime without restarting the application from Django admin panel.
 
@@ -12,7 +12,6 @@ pip install django-knobs
 
 ![](docs/assets/banner.png)
 
-
 ## Setup
 
 **1. Add to `INSTALLED_APPS`:**

docs/quickstart.md docs/index.mddocs/quickstart.md renamed to docs/index.md

@@ -30,7 +30,7 @@ site_author = "Dima Anfimov"
 # The site_url is the canonical URL for your site. When building online
 # documentation you should set this.
 # Read more: https://zensical.org/docs/setup/basics/#site_url
-#site_url = "https://www.example.com/"
+site_url = "https://danfimov.github.io/django-knobs/"
 
 # The copyright notice appears in the page footer and can contain an HTML
 # fragment.
@@ -48,14 +48,16 @@ Copyright © 2026 The authors
 #
 # Read more: https://zensical.org/docs/setup/navigation/
 nav = [
-  { "Quickstart" = "quickstart.md" },
+  { "Quickstart" = "index.md" },
   { "Settings" = "settings.md" },
   { "Caching" = "caching.md" },
   { "Extensions" = [
       "extensions/history.md"
   ]}
 ]
 
+use_directory_urls = true
+
 # With the "extra_css" option you can add your own CSS styling to customize
 # your Zensical project according to your needs. You can add any number of
 # CSS files.