more clear headings, a slight re-structure

ofloveandhate · Jul 24, 2024 · ec5cebf · ec5cebf
1 parent 0d86e32
commit ec5cebf
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 19 deletions.
diff --git a/docs/emoji.rst b/docs/emoji.rst
@@ -1,4 +1,4 @@
-Emojification
+🙂 Emojification
 ==================
 
 

diff --git a/docs/gotchas.rst b/docs/gotchas.rst
@@ -1,5 +1,5 @@
-Gotchas
-==========
+💥 Gotchas
+===========
 
 
 There are some idiosyncrasies in `markdown2canvas`.  This page is me doing my best to share them with you.

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@ This is the documentation for `markdown2canvas`, a Python library for containeri
    :maxdepth: 2
    :caption: Contents:
 
-Tutorials
+Tutorials 👩‍🏫
 ================
 
 .. toctree::
@@ -30,34 +30,44 @@ Tutorials
 
 
 
-.. _Top_Notes:
-
-Notes
-========
+Usage notes
+=================================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Some useful notes on aspects of using the library
 
    gotchas
    emoji
    on_meta_dot_json
    markdown_1
    making_links_to_existing_content
-   wishlist
-   unit_tests
-   history
 
 
 
-Useful links
-==============
+
+
+
+Useful links 🔗
+================
 
 * `Canvas API documentation at root level <https://canvasapi.readthedocs.io/en/stable/>`_
 * `Canvas API class documentation <https://canvasapi.readthedocs.io/en/stable/class-reference.html>`_  I use this when chasing down how to set additional properties for various content types.  
 
 
 
+Implementation notes
+=======================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Notes about library implementation
+
+   wishlist
+   unit_tests
+   history
+
+
 Details 📝
 ================
 

diff --git a/docs/on_meta_dot_json.rst b/docs/on_meta_dot_json.rst
@@ -6,10 +6,6 @@ The `meta.json` file must be present in every containerized content folder.
 
 
 
-Valid properties
------------------
-
-
 meta.json for ALL content types
 *********************************
 
@@ -130,7 +126,7 @@ Optional:
 
 
 What happens if I specify a property / key that's not used or is invalid?
------------------------------------------------------------------------------
+*****************************************************************************
 
 * Extra keys are ignored with no message.  
 * Missing required keys hopefully WILL generate a problem!!!