Skip to content

Commit 0aeabb8

Browse files
committed
Update the top level readme
1 parent 541dd4d commit 0aeabb8

2 files changed

Lines changed: 40 additions & 2 deletions

File tree

docs_dev/readme_toplevel.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
1-
# Hello world
1+
# Logging in DUNE-DAQ — Documentation
2+
3+
Welcome to the logging documentation for daqpytools (as of 5.6.0).
4+
5+
This documentation is split into two sections depending on your role:
6+
7+
- **User docs** — for anyone writing Python applications that use logging
8+
- **Developer docs** — for anyone extending the logging system itself (new handlers, new filters)
9+
10+
---
11+
12+
## User documentation
13+
14+
| Page | What it's for |
15+
|---|---|
16+
| [Tutorial](./user/tutorial.md) | Get a working logger running from scratch |
17+
| [Concepts & explanation](./user/explanation.md) | Understand how Python logging and daqpytools work |
18+
| [How to use handlers and filters](./user/how-to/use-handlers.md) | Descriptions and examples for each handler and filter |
19+
| [How to route messages](./user/how-to/route-messages.md) | Direct records to specific handlers using HandlerType and LogHandlerConf |
20+
| [How to add handlers at runtime](./user/how-to/add-handlers-at-runtime.md) | Attach handlers after logger creation; pass kwargs |
21+
| [How to configure ERS](./user/how-to/configure-ers.md) | Attach and use ERS handlers |
22+
| [Best practices](./user/how-to/best-practices.md) | Recommended patterns for structuring logging in your application |
23+
| [Troubleshooting](./user/reference/troubleshooting.md) | Common symptoms, causes, and fixes |
24+
| [API reference](https://dune-daq.github.io/daqpytools/APIref) | Auto-generated kwargs, types, and defaults for all public APIs |
25+
26+
---
27+
28+
## Developer documentation
29+
30+
| Page | What it's for |
31+
|---|---|
32+
| [Concepts & explanation](./dev/explanation.md) | The routing model, component definitions, fallback logic |
33+
| [Architecture reference](./dev/reference/architecture.md) | Logger init flow and record flow at runtime |
34+
| [How to add a handler](./dev/how-to/add-a-handler.md) | Step-by-step guide to adding a new handler type |
35+
| [How to add a filter](./dev/how-to/add-a-filter.md) | Step-by-step guide to adding a new logger-level filter |
36+
| [How to debug routing](./dev/how-to/debug-routing.md) | Systematic workflow for diagnosing routing issues |
37+
| [Common patterns](./dev/reference/patterns.md) | Quick-reference recipes for handlers and filters |

docs_dev/utils/mirror_docs.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
from pathlib import Path
1313

1414
DOCS_DEV_EXCLUDE = {
15-
15+
"utils",
16+
"requirements.txt",
17+
"readme_toplevel.md",
1618
}
1719

1820

0 commit comments

Comments
 (0)