Documentation + cleanup

openzim · Oct 12, 2023 · 9d8803c · 9d8803c
1 parent ae47164
commit 9d8803c
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 6 deletions.
diff --git a/scraper/src/kolibri2zim/schemas.py b/scraper/src/kolibri2zim/schemas.py
@@ -2,6 +2,8 @@
 
 
 class TopicSubSection(BaseModel):
+    """One subclass to serialize data about one Kolibri topic"""
+
     slug: str
     title: str
     description: str
@@ -10,6 +12,8 @@ class TopicSubSection(BaseModel):
 
 
 class TopicSection(BaseModel):
+    """Another subclass to serialize data about one Kolibri topic"""
+
     slug: str
     title: str
     description: str
@@ -19,6 +23,13 @@ class TopicSection(BaseModel):
 
 
 class Topic(BaseModel):
+    """Class to serialize data about one Kolibri topic
+
+    One topic is composed of parents, sections and subsections.
+    This is already preprocessed information, closely adapted
+    to current UI needs
+    """
+
     parents: list[str]
     title: str
     description: str
@@ -27,4 +38,6 @@ class Topic(BaseModel):
 
 
 class Channel(BaseModel):
+    """Class to serialize data about the Kolibri channel"""
+
     root: str
diff --git a/scraper/src/kolibri2zim/templates/base.html b/scraper/src/kolibri2zim/templates/base.html
@@ -24,8 +24,7 @@
   <div class="container">
     {% if false and parents_count %}
     <!-- This navigation is broken due to the move to Vue.JS / slug-based URLs
-      This won't be needed anyway once the move to Vue.JS is finished and we
-      can probably live without it until then (or fix it later on).
+      To be fixed by https://github.com/openzim/kolibri/issues/64
     -->
     <nav style="--bs-breadcrumb-divider: '>';" aria-label="breadcrumb">
       <ol class="breadcrumb">
@@ -39,6 +38,7 @@
 
     <!-- This is a hack for epub rendering due to a probable bug in epub.js
       The bug is that iframe is moved up when the epub is rendered
+      To be fixed by https://github.com/openzim/kolibri/issues/63
     -->
     {% if is_epub %}
     <p style="height: 30px;">&nbsp;</p>

diff --git a/zimui/.gitignore b/zimui/.gitignore
@@ -1,6 +1,5 @@
 node_modules
 
-public/fcc
 dist
 dist-ssr
 *.l

diff --git a/zimui/index.html b/zimui/index.html
@@ -1,8 +1,8 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <link rel="icon" type="image/x-icon" href="./favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Kolibri channel in a ZIM</title>
   </head>

diff --git a/zimui/public/vite.svg b/zimui/public/vite.svg
diff --git a/zimui/src/assets/a886c13e06bd9f7fed9e661b31897edc.png b/zimui/src/assets/a886c13e06bd9f7fed9e661b31897edc.png
diff --git a/zimui/src/assets/ebe9e09a4d0e417b051d60ff9891f98e.png b/zimui/src/assets/ebe9e09a4d0e417b051d60ff9891f98e.png