Update the top level readme

Author: emmuhamm

docs_dev/readme_toplevel.md

@@ -1 +1,37 @@
-# Hello world
+# Logging in DUNE-DAQ — Documentation
+
+Welcome to the logging documentation for daqpytools (as of 5.6.0).
+
+This documentation is split into two sections depending on your role:
+
+- **User docs** — for anyone writing Python applications that use logging
+- **Developer docs** — for anyone extending the logging system itself (new handlers, new filters)
+
+---
+
+## User documentation
+
+| Page | What it's for |
+|---|---|
+| [Tutorial](./user/tutorial.md) | Get a working logger running from scratch |
+| [Concepts & explanation](./user/explanation.md) | Understand how Python logging and daqpytools work |
+| [How to use handlers and filters](./user/how-to/use-handlers.md) | Descriptions and examples for each handler and filter |
+| [How to route messages](./user/how-to/route-messages.md) | Direct records to specific handlers using HandlerType and LogHandlerConf |
+| [How to add handlers at runtime](./user/how-to/add-handlers-at-runtime.md) | Attach handlers after logger creation; pass kwargs |
+| [How to configure ERS](./user/how-to/configure-ers.md) | Attach and use ERS handlers |
+| [Best practices](./user/how-to/best-practices.md) | Recommended patterns for structuring logging in your application |
+| [Troubleshooting](./user/reference/troubleshooting.md) | Common symptoms, causes, and fixes |
+| [API reference](https://dune-daq.github.io/daqpytools/APIref) | Auto-generated kwargs, types, and defaults for all public APIs |
+
+---
+
+## Developer documentation
+
+| Page | What it's for |
+|---|---|
+| [Concepts & explanation](./dev/explanation.md) | The routing model, component definitions, fallback logic |
+| [Architecture reference](./dev/reference/architecture.md) | Logger init flow and record flow at runtime |
+| [How to add a handler](./dev/how-to/add-a-handler.md) | Step-by-step guide to adding a new handler type |
+| [How to add a filter](./dev/how-to/add-a-filter.md) | Step-by-step guide to adding a new logger-level filter |
+| [How to debug routing](./dev/how-to/debug-routing.md) | Systematic workflow for diagnosing routing issues |
+| [Common patterns](./dev/reference/patterns.md) | Quick-reference recipes for handlers and filters |

docs_dev/utils/mirror_docs.py

@@ -4,15 +4,18 @@
 Virtual output structure:
     readme.md        ← from docs_dev/readme_toplevel.md
     user/            ← from docs/
-    dev/             ← from docs_dev/ (excluding utils/, requirements.txt, readme_toplevel.md)
+    dev/             ← from docs_dev/ (excluding utils/,
+                       requirements.txt, readme_toplevel.md)
 """
 
 from __future__ import annotations
 
 from pathlib import Path
 
 DOCS_DEV_EXCLUDE = {
-
+    "utils",
+    "requirements.txt",
+    "readme_toplevel.md",
 }
 
 
@@ -64,21 +67,21 @@ def _run_from_mkdocs_gen_files() -> None:
         with mkdocs_gen_files.open("README.md", "wb") as fd:
             fd.write(readme_source.read_bytes())
     else:
-        print(f"Warning: '{readme_source}' does not exist, skipping.")
+        print(f"Warning: '{readme_source}' does not exist, skipping.")  # noqa: T201
 
     # 2. docs/ → virtual user/
     docs_dir = repo_root / "docs"
     if docs_dir.exists():
         _mirror_into_virtual_fs(docs_dir, "user")
     else:
-        print(f"Warning: '{docs_dir}' does not exist, skipping.")
+        print(f"Warning: '{docs_dir}' does not exist, skipping.")  # noqa: T201
 
     # 3. docs_dev/ → virtual dev/ (with exclusions)
     docs_dev_dir = repo_root / "docs_dev"
     if docs_dev_dir.exists():
         _mirror_into_virtual_fs(docs_dev_dir, "dev", exclude=DOCS_DEV_EXCLUDE)
     else:
-        print(f"Warning: '{docs_dev_dir}' does not exist, skipping.")
+        print(f"Warning: '{docs_dev_dir}' does not exist, skipping.")  # noqa: T201
 
 
 if __name__ != "__main__":