mention docs and pre-commit in README

README.md

@@ -1,7 +1,25 @@
 # Servala Portal
 
+![Servala Logo](/docs/modules/ROOT/assets/images/servala.png)
+
 The Servala Self-Service Portal
 
+## Documentation
+
+Available at https://docs.servala.com/.
+
+The project documentation is written in [AsciiDoc](https://docs.asciidoctor.org/asciidoc/latest/) and built with [Antora](https://docs.antora.org/antora/latest/).
+It's automatically packaged and deployed by the CI/CD pipeline found in `.forgejo/workflows/docs.yaml`.
+
+Paths:
+
+* `docs/modules/ROOT/pages`: Documentation pages
+* `docs/modules/ROOT/assets/images`: Images to be included in the documentation pages
+* `docs/modules/ROOT/nav.adoc`: Site navigation (new pages need to be added there)
+
+Writing documentation is best done by running `make docs-preview` and connecting to the site at http://localhost:2020/.
+The browser addon [LiveReload - Web extension](https://addons.mozilla.org/en-US/firefox/addon/livereload-web-extension/) will help while editing with automated page reload in the browser.
+
 ## Development setup
 
 First, copy the ``.env.example`` file to ``.env`` and adjust the settings to your needs.
@@ -33,6 +51,9 @@ uv run djlint src/ --reformat --format-js --format-css  # Format templates, JS a
 uv run flake8 src/  # Python linter
 ```
 
+The repository features a [pre-commit](https://pre-commit.com/) configuration which helps to properly format the source code before committing.
+It's recommended to install and use it.
+
 ### Docker
 
 The project provides a Dockerfile which builds a production-ready container image.