Bundle: Add suggestions from code review by CodeRabbit

Author: amotl

src/cratedb_about/bundle/llmstxt.py

@@ -1,14 +1,14 @@
 import dataclasses
 import logging
 import shutil
-import typing as t
 from importlib import resources
 from importlib.abc import Traversable
 from pathlib import Path
 
 from markdown import markdown
 
 from cratedb_about import CrateDbKnowledgeOutline
+from cratedb_about.outline import OutlineDocument
 from cratedb_about.util import get_hostname, get_now
 
 logger = logging.getLogger(__name__)
@@ -17,12 +17,15 @@
 @dataclasses.dataclass
 class LllmsTxtBuilder:
     """
-    Build llms.txt files for CrateDB.
+    Generate llms.txt files.
+
+    This is a base class intended to be subclassed. The non-init fields
+    (outline, readme_md, outline_yaml) should be initialized by subclasses.
     """
 
     outline_url: str
     outdir: Path
-    outline: t.Any = dataclasses.field(init=False)
+    outline: OutlineDocument = dataclasses.field(init=False)
     readme_md: Traversable = dataclasses.field(init=False)
     outline_yaml: Traversable = dataclasses.field(init=False)
 
@@ -71,13 +74,16 @@ def copy_sources(self):
             str(self.outline_yaml),
             self.outdir / "outline.yaml",
         )
-        Path(self.outdir / "outline.html").write_text(self.outline.to_html())
+        try:
+            Path(self.outdir / "outline.html").write_text(self.outline.to_html())
+        except Exception as e:
+            logger.warning(f"Failed to generate HTML outline: {e}")
 
 
 @dataclasses.dataclass
 class CrateDbLllmsTxtBuilder(LllmsTxtBuilder):
     """
-    Build llms.txt files for CrateDB.
+    Generate llms.txt files for CrateDB.
     """
 
     readme_md: Traversable = resources.files("cratedb_about.bundle") / "readme.md"

src/cratedb_about/outline/model.py

@@ -81,6 +81,9 @@ def to_markdown(self) -> str:
         return buffer.getvalue().strip()
 
     def to_html(self) -> str:
+        """
+        Convert outline into HTML format using Markdown as an intermediate step.
+        """
         return markdown(self.to_markdown())
 
     def to_llms_txt(self, optional: bool = False) -> str: