Improve documentation and comments in SushiChef getting started example

Author: gab-8323

examples/gettingstarted/sushichef.py

@@ -1,4 +1,16 @@
 #!/usr/bin/env python
+"""
+Getting Started Example: SushiChef
+
+This example demonstrates a minimal SushiChef implementation for creating
+a simple Kolibri channel with one topic and one document.
+
+Note:
+- This example is intended for demonstration purposes only.
+- Some external URLs used here may become unavailable over time.
+- The example may involve concepts that are not ideal for absolute beginners.
+"""
+
 from ricecooker.chefs import SushiChef
 from ricecooker.classes.files import DocumentFile
 from ricecooker.classes.licenses import get_license
@@ -12,14 +24,19 @@ class SimpleChef(SushiChef):
         "CHANNEL_SOURCE_DOMAIN": "<yourdomain.org>",  # where content comes from
         "CHANNEL_SOURCE_ID": "<unique id for the channel>",  # CHANGE ME!!!
         "CHANNEL_LANGUAGE": "en",  # le_utils language code
-        "CHANNEL_THUMBNAIL": "https://upload.wikimedia.org/wikipedia/commons/b/b7/A_Grande_Batata.jpg",  # (optional)
+        "CHANNEL_THUMBNAIL": "https://upload.wikimedia.org/wikipedia/commons/b/b7/A_Grande_Batata.jpg",  # Example external image URL (may change or become unavailable)
         "CHANNEL_DESCRIPTION": "What is this channel about?",  # (optional)
     }
 
     def construct_channel(self, **kwargs):
+        # Create the main channel object
         channel = self.get_channel(**kwargs)
+
+        # Add a topic node for potatoes
         potato_topic = TopicNode(title="Potatoes!", source_id="<potatoes_id>")
         channel.add_child(potato_topic)
+
+        # Add a document node under the potato topic
         document_node = DocumentNode(
             title="Growing potatoes",
             description="An article about growing potatoes on your rooftop.",
@@ -28,19 +45,22 @@ def construct_channel(self, **kwargs):
             language="en",
             files=[
                 DocumentFile(
-                    path="https://www.gov.mb.ca/inr/pdf/pubs/mafri-potatoe.pdf",
+                    path="https://www.gov.mb.ca/inr/pdf/pubs/mafri-potatoe.pdf",  # Example external PDF URL
                     language="en",
                 )
             ],
         )
         potato_topic.add_child(document_node)
+
         return channel
 
 
 if __name__ == "__main__":
     """
-    Run this script on the command line using:
-        python sushichef.py  --token=YOURTOKENHERE9139139f3a23232
+    Run this script from the command line using:
+        python sushichef.py --token=YOUR_TOKEN_HERE
+
+    Replace YOUR_TOKEN_HERE with a valid Kolibri Studio token.
     """
     simple_chef = SimpleChef()
     simple_chef.main()