Logging as a single chapter.

This is the direction we want to go with documentation. Major areas of functionality should be one single chapter in the API reference, which should make them far more usable for people not already familiar with NNG. This represents a substantial departure from UNIX man pages, but many of our users are not used to working with UNIX man pages anyway, and organization of man pages, while convenient for reading with the legacy shell man command, fails on a number of usability fronts.
nanomsg · Oct 19, 2024 · 663d83b · 663d83b
1 parent 8f42f78
commit 663d83b
Show file tree

Hide file tree

Showing 8 changed files with 185 additions and 232 deletions.
diff --git a/docs/book.toml b/docs/book.toml
@@ -8,10 +8,17 @@ title = "NNG Reference Manual (DRAFT)"
 [output.html]
 smart-punctuation = true
 fold.enable = true
-fold.level = 1
+fold.level = 2
+additional-css = ["theme/pagetoc.css"]
+additional-js = ["theme/pagetoc.js"]
 
 [preprocessor.alerts]
 
 [preprocessor.indexing]
 
 [preprocessor.footnote]
+
+# [preprocessor.inline-highlighting]
+# default-language = "c"
+
+[preprocessor.pagetoc]
diff --git a/docs/ref/SUMMARY.md b/docs/ref/SUMMARY.md
@@ -24,12 +24,7 @@
     - [nng_mtx](./api/thr/nng_mtx.md)
     - [nng_thread](./api/thr/nng_thread.md)
 
-  - [Logging](./api/log/index.md)
-
-    - [nng_log](./api/log/nng_log.md)
-    - [nng_log_facility](./api/log/nng_log_facility.md)
-    - [nng_log_level](./api/log/nng_log_level.md)
-    - [nng_log_logger](./api/log/nng_log_logger.md)
+  - [Logging](./api/logging.md)
 
   - [Statistics](./api/stat/index.md)
 

diff --git a/docs/ref/api/log/index.md b/docs/ref/api/log/index.md
diff --git a/docs/ref/api/log/nng_log.md b/docs/ref/api/log/nng_log.md
diff --git a/docs/ref/api/log/nng_log_facility.md b/docs/ref/api/log/nng_log_facility.md
diff --git a/docs/ref/api/log/nng_log_level.md b/docs/ref/api/log/nng_log_level.md
diff --git a/docs/ref/api/log/nng_log_logger.md b/docs/ref/api/log/nng_log_logger.md