documentation update

sinaahmadi · Nov 12, 2020 · 9cf4485 · 9cf4485
1 parent 5cfea10
commit 9cf4485
Show file tree

Hide file tree

Showing 73 changed files with 15,134 additions and 166 deletions.
diff --git a/README.md b/README.md
@@ -5,14 +5,17 @@
 </p>
 
 <p align="center">
-    <a href="https://circleci.com/gh/huggingface/transformers">
+    <a href="">
         <img alt="Build" src="https://badges.frapsoft.com/os/v1/open-source.png?v=103">
     </a>
     <a href="https://github.com/sinaahmadi/KLPT/blob/master/LICENSE">
         <img alt="GitHub" src="https://img.shields.io/badge/license-CC%20BY--SA%204.0-blue">
     </a>
     <a href="https://sinaahmadi.github.io/klpt/">
-        <img alt="Documentation" src="https://img.shields.io/website?down_color=red&down_message=offline&up_color=orange&url=https%3A%2F%2Fsinaahmadi.github.io%2FKLPT%2F">
+        <img alt="Documentation" src="https://img.shields.io/website?down_color=green&down_message=online&up_color=orange&url=https%3A%2F%2Fsinaahmadi.github.io%2FKLPT%2F">
+    </a>
+    <a href="https://gitter.im/KurdishNLP/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge">
+      <img alt="Documentation" src="https://badges.gitter.im/KurdishNLP/community.svg">
     </a>
 </p>
 
@@ -23,7 +26,7 @@
 ### Welcome / *Hûn bi xêr hatin* / بە خێر بێن! 🙂
 
 
-Kurdish Language Processing Toolkit--KLPT is a [natural language processing](https://en.wikipedia.org/wiki/Natural_language_processing) (NLP) toolkit in Python for the [Kurdish language](https://en.wikipedia.org/wiki/Kurdish_languages). The current version comes with four core modules, namely `preprocess`, `stem`, `transliterate` and `tokenize` and addresses basic language processing tasks such as text preprocessing, stemming, tokenziation, spell-checking and morphological analysis for the [Sorani](https://en.wikipedia.org/wiki/Sorani) and the [Kurmanji](https://en.wikipedia.org/wiki/Kurmanji) dialects of Kurdish.
+Kurdish Language Processing Toolkit--KLPT is a [natural language processing](https://en.wikipedia.org/wiki/Natural_language_processing) (NLP) toolkit in Python for the [Kurdish language](https://en.wikipedia.org/wiki/Kurdish_languages). The current version comes with four core modules, namely `preprocess`, `stem`, `transliterate` and `tokenize` and addresses basic language processing tasks such as text preprocessing, stemming, tokenization, spell-checking and morphological analysis for the [Sorani](https://en.wikipedia.org/wiki/Sorani) and the [Kurmanji](https://en.wikipedia.org/wiki/Kurmanji) dialects of Kurdish.
 
 
 ## Install KLPT

diff --git a/cinder/base.html b/cinder/base.html
@@ -88,7 +88,7 @@
             <p>{% if config.copyright %}
             <small>{{ config.copyright }}</small><br>
             {% endif %}
-            <small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
+            <small>&copy; 2020 KLPT - Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
             </p>
           {% endif %}
 

diff --git a/cinder/nav.html b/cinder/nav.html
@@ -20,6 +20,7 @@
             {% endif %}
         </div>
 
+
         <!-- Expanded navigation -->
         <div class="navbar-collapse collapse">
             {%- block site_nav %}
@@ -75,15 +76,15 @@
                 {%- block repo %}
                     {%- if page and page.edit_url %}
                     <li>
-                        <a href="{{ page.edit_url }}">
+                        <a href="{{ config.repo_url }}">
                             {%- if config.repo_name == 'GitHub' -%}
-                            <i class="fab fa-github"></i> Edit on {{ config.repo_name }}
+                            <i class="fab fa-github"></i> {{ config.repo_name }}
                             {%- elif config.repo_name == 'Bitbucket' -%}
                             <i class="fab fa-bitbucket"></i> Edit on {{ config.repo_name }}
                             {%- elif config.repo_name == 'GitLab' -%}
                             <i class="fab fa-gitlab"></i> Edit on {{ config.repo_name }}
                             {%- else -%}
-                            Edit on {{ config.repo_name }}
+                            {{ config.repo_name }}
                             {%- endif -%}
                         </a>
                     </li>

diff --git a/cinder/toc.html b/cinder/toc.html
@@ -1,4 +1,6 @@
+
 <div class="bs-sidebar hidden-print affix well" role="complementary">
+
     <ul class="nav bs-sidenav">
         {%- for toc_item in page.toc %}
         <li class="first-level {% if toc_item.active %}active{% endif %}"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>

diff --git a/docs/about/contributing.md b/docs/about/contributing.md
@@ -1,18 +1,19 @@
-## How to help
+# How to help Kurdish language processing?
 
-One of our main objectives in this project is to promote collaborative projects with **open-source** outcomes. If you are generous enough to volunteer, like us, and help the Kurdish language, there are three ways you can do to:
+One of our main objectives in this project is to promote collaborative projects with **open-source** outcomes. If you are generous and passionate to volunteer and help the Kurdish language, there are three ways you can do so:
 
-1- If you have expertise in Kurdish linguistics, you can take part in annotation tasks. Having a basic understanding on computational linguistics is a plus but not a must.
-2- If you are iffy about your knowledge in Kurdish but have expertise in computer programming, you can also contribute to this project.
-3- If you are not included in 1 and 2 but have basic knowledge about Kurdish, particularly writing in Kurdish, you can contribute to lexicon development. The current lexicons include less than 20,000 headwords which should be further extended.
+1. If you are a native Kurdish speaker with general knowledge about Kurdish and are comfortable working with computer, [contributing to collaboratively-curated resources](https://en.wikipedia.org/wiki/Wikipedia:Contributing_to_Wikipedia) is the best starting point, particularly to:
+	- [Wîkîferheng - the Kurdish Wiktionary](https://ku.wiktionary.org/wiki/Destp%C3%AAk)
+	- Wikipedia in [Sorani](https://ckb.wikipedia.org/wiki/%D8%AF%DB%95%D8%B3%D8%AA%D9%BE%DB%8E%DA%A9) and in [Kurmanji](https://ku.wikipedia.org/wiki/Destp%C3%AAk)
+2. If you have expertise in Kurdish linguistics, you can take part in annotation tasks. Having a basic understanding on computational linguistics is a plus but not a must. Please get in touch by joining the [KurdishNLP community on Gitter](https://gitter.im/KurdishNLP). **Our collaborations oftentimes lead to a scientific paper** depending on the task. Please check the following repositories to find out about some of our previous projects:
+	- [Kurdish tokenization](https://github.com/sinaahmadi/KurdishTokenization)
+	- [Kurdish Hunspell](https://github.com/sinaahmadi/KurdishHunspell)
+	- [Kurdish transliteration](https://github.com/sinaahmadi/wergor)
 
-In any case, please follow this project and introduce it to your surrounding. Test the tool and raise your issues so that we can fix them.
+3. If you are not included in 1 and 2 but have basic knowledge about Kurdish, particularly writing in Kurdish, you are invited to create content online. You can start creating a blog or tweet in Kurdish. After all, **every single person is a contributor as well**.
 
+In any case, please follow this project and introduce it to your friends. Test the tool and raise your issues so that we can fix them.
 
 
 
-## What is next?
 
-
-
-I am aware that many Kurds are interested in their language and many times, they invest their passion into literature. Well, that's amazing, but we are living in the IT era. We do need poets and novelists, but programmer and NLP engineers too. Therefore, I am planning to initiate an NLP course in Kurdish in the coming months.