[gtk-web/new-website: 103/191] updated documentation

[Emmanuele Bassi <ebassi src gnome org>]

commit 8be14df596f5a741fd1607d96f9837bf843d9394
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date:   Mon Jul 15 18:58:27 2019 +0530

    updated documentation

 _data/navigation.yml        |  16 +++----
 _data/stuff.yml             |  20 ++++++++
 _layouts/documentation.html | 110 ++++++++++++++++++++++----------------------
 3 files changed, 84 insertions(+), 62 deletions(-)
---
diff --git a/_data/navigation.yml b/_data/navigation.yml
index 759afe9..e95aab5 100644
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -1,17 +1,18 @@
 # This file contains the navigation links present in the header and footer of the website
 
+# to add sections to the footer of the website, add a section with the following attributes:
+#   title: the display text for the section
+menu_links_sections:
+  - title: Project
+  - title: Support
+  - title: Company
+
 # To add navigation links to the website, add a new link with the following attributes:
 #   name: display text of the link
 #   href: the location where the link points to
 #   header: set this to 'true' if the link should be present in the header, else set 'false'
 #   footer: set this to 'true' if the link should be present in the footer, else set 'false'
-#   section: if footer is set to 'true', specify the name of the section the link belongs
-
-# sections in footer are:
-#   Project
-#   Company
-#   Support
-
+#   section: if footer is set to 'true', specify the name of the section the link belongs. Make sure that 
the section exists.
 menu_links:
   - name: GTK
     href: /
@@ -107,7 +108,6 @@ menu_links:
 # To add social links to the website, add a new social link with the following attributes:
 #   icon: the name of the icon on https://fontawesome.com/icons
 #   href: link to the social media profile
-
 social_links:
   - icon: fab fa-twitter
     href: https://twitter.com/GTKtoolkit/
diff --git a/_data/stuff.yml b/_data/stuff.yml
index 05cf68f..95e01a5 100644
--- a/_data/stuff.yml
+++ b/_data/stuff.yml
@@ -1,9 +1,25 @@
+# this file contains some important global variables that belong to more than one page of the website
+
+# tell about the gtk project in as less words as possible.
 mini_description: GTK is a free and open-source cross-platform widget toolkit for creating graphical user 
interfaces.
+
+# the current stable version of GTK
 gtkVersion: 3.96
+
+# the current stable version of GTK
 site_repo: https://gitlab.gnome.org/ravgeetdhillon/gtk-web/
+
+# link to the GTK introduction/tutorial video
 tutorial_video_link: https://www.youtube.com/embed/bNA-Q8fQqTc
+
+#gtk websites logo name
 logo: gtk-logo.ico
 
+# read out the CONTRIBUTING.md to know how to add documentation pages to the website
+
+# to add sections to the sidebar on the documentation pages of the website, add a section with the following 
attributes:
+#   title: the display text for the section
+#   name: the name of the file
 sidebar_sections:
   - title: Getting Started
     name: getting-started
@@ -18,6 +34,10 @@ sidebar_sections:
   - title: Architecture
     name: architecture
 
+# to add links to the sidebar on the documentation pages of the website, add a link with the following 
attributes:
+#   title: the display text for the section
+#   name: the name of the `.md` file, to which the link should point
+#   section: the name of the section the link belongs to
 sidebar_links:
   - title: Mono Develop
     name: mono-develop
diff --git a/_layouts/documentation.html b/_layouts/documentation.html
index 5fd04d0..159d605 100644
--- a/_layouts/documentation.html
+++ b/_layouts/documentation.html
@@ -1,64 +1,66 @@
 {%- include header.html -%}
 
 <section class="pb-4" id="{{ page.name }}">
-    <div class="container-fluid">
-        <div class="row">
-            <div class="col-lg-3 col-md-4 small p-0 order-2 order-md-1">
-                <div class="text-break pt-4 px-4 border-right h-100">
-                    <ul class="list-group">
-                    {% for section in site.data.stuff.sidebar_sections %}
-                        <li class="list-group-item border-0 group-header pb-4"><a href="/docs/{{ 
section.name }}" class="text-dark"><strong>{{ section.title }}</strong></a>
-                            {% assign sidebar_links = site.data.stuff.sidebar_links | where: "section", 
section.title %}
-                                <ul class="list-group">
-                                    {% for link in sidebar_links %}
-                                        {% if link.href %}
-                                            <li class="list-group-item border-0 p-0 pt-2"><a href="{{ 
link.href }}" class="text-muted">{{ link.title }}</a></li>
-                                        {% else %}
-                                            <li class="list-group-item border-0 p-0 pt-2"><a href="/docs/{{ 
section.name }}/{{ link.name }}" class="text-muted">{{ link.title }}</a></li>
-                                        {% endif %}
-                                    {% endfor %}
-                                </ul>
-                            {% endfor %}
-                        </li>
-                    </ul>
-                </div>
-            </div>
-            <div class="col-lg-7 col-md-8 py-4 px-sm-4 order-1 order-md-2 bg-light">
-                <div class="d-flex flex-sm-row flex-column py-3 py-md-0 px-3 px-md-0 app-shadow">
-                    <div class="w-100">
-                        <nav aria-label="breadcrumb">
-                            <ol class="breadcrumb small bg-transparent pl-0 m-0">
-                                {% assign url = page.url | split: '/' %}
-                                {% for part in url  %}
-                                    {% if forloop.last == true  %}
-                                        <li class="breadcrumb-item active" aria-current="page">{{ part 
}}</li>
-                                    {% else %}
-                                        <li class="breadcrumb-item"><a href="#">{{ part }}</a></li>
-                                    {% endif %}
-                                {% endfor %}
-                            </ol>
-                        </nav>
-                    </div>
-                </div>
-                <br>
-                <article class="markdown-body">
-                {{ page.content }}
-                </article>
-            </div>
-            <div class="col-lg-2 col-md-12 small text-break mt-4 p-0 pl-3 order-3 order-md-3">
-                <div class="mr-3 px-3 py-3 border rounded shadow-sm">
-                    <p class="mb-0">Observed a typo or some missing information, edit this page <a 
href="#">here</a>.</p>
-                    <br>
-                    <p class="mb-0">Read on <a href="#">how to contribute</a> to this website.</p>
-                </div>
-            </div>
+  <div class="container-fluid">
+    <div class="row">
+      <div class="col-lg-3 col-md-4 small p-0 order-2 order-md-1">
+        <div class="text-break pt-4 px-4 border-right h-100">
+          <ul class="list-group">
+            {% for section in site.data.stuff.sidebar_sections %}
+            <li class="list-group-item border-0 group-header pb-4"><a href="/docs/{{ section.name }}" 
class="text-dark"><strong>{{ section.title }}</strong></a>
+              {% assign sidebar_links = site.data.stuff.sidebar_links | where: "section", section.title %}
+              <ul class="list-group">
+                {% for link in sidebar_links %}
+                  {% if link.href %}
+                    <li class="list-group-item border-0 p-0 pt-2"><a href="{{ link.href }}" 
class="text-muted">{{ link.title }}</a></li>
+                  {% else %}
+                    <li class="list-group-item border-0 p-0 pt-2"><a href="/docs/{{ section.name }}/{{ 
link.name }}" class="text-muted">{{ link.title }}</a></li>
+                  {% endif %}
+                {% endfor %}
+              </ul>
+            </li>
+            {% endfor %}
+          </ul>
         </div>
+      </div>
+      <div class="col-lg-7 col-md-8 py-4 px-sm-4 order-1 order-md-2 bg-light">
+        <div class="d-flex flex-sm-row flex-column py-3 py-md-0 px-3 px-md-0 app-shadow">
+          <div class="w-100">
+            <nav aria-label="breadcrumb">
+              <ol class="breadcrumb small bg-transparent pl-0 m-0">
+                {% assign url = page.url | split: '/' %}
+                {% for part in url %}
+                  {% if forloop.last == true %}
+                    <li class="breadcrumb-item active" aria-current="page">{{ part }}</li>
+                  {% else %}
+                    <li class="breadcrumb-item"><a href="#">{{ part }}</a></li>
+                  {% endif %}
+                {% endfor %}
+              </ol>
+            </nav>
+          </div>
+        </div>
+        <br>
+        <article class="markdown-body">
+          {{ page.content }}
+        </article>
+      </div>
+      <div class="col-lg-2 col-md-12 small text-break mt-4 p-0 pl-3 order-3 order-md-3">
+        <div class="mr-3 px-3 py-3 border rounded shadow-sm">
+          {% assign page_name = page.path | split: '/' %}
+          {% assign page_name = page_name.last %}
+          <p class="mb-0">Observed a typo or some missing information, edit this page <a 
href="https://gitlab.gnome.org/ravgeetdhillon/gtk-web/blob/master/collections/_docs/{{ page_name 
}}">here</a>.</p>
+          <br>
+          <p class="mb-0">Read on <a 
href="https://gitlab.gnome.org/ravgeetdhillon/gtk-web/blob/master/CONTRIBUTING.md";>how to contribute</a> to 
this website.</p>
+        </div>
+      </div>
     </div>
+  </div>
 </section>
 
 <script>
-    $(document).ready(function(){
-        $('[data-toggle="tooltip"]').tooltip();
-    });
+  $(document).ready(function () {
+    $('[data-toggle="tooltip"]').tooltip();
+  });
 </script>
 {%- include footer.html -%}
\ No newline at end of file