Update documentation links

armbian · Apr 7, 2024 · b9dbedc · b9dbedc
1 parent c7fa986
commit b9dbedc
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ To use the utility as a user, run the following command:
 ***
 
 Following was Generated on:
-Sun Apr  7 01:57:36 AM MST 2024.
+Sun Apr  7 09:59:24 AM MST 2024.
 
 ***
 
@@ -51,9 +51,9 @@ System wide and admin settings
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| S01 | Enable Armbina kernal upgrades |  | X | X | Ref or doc Needed |
-| S02 | Disable Armbina kernal upgrades |  | X | X | Ref or doc Needed |
-| S03 | Edit the boot enviroment (WIP) |  | X | X | Ref or doc Needed |
+| S01 | Enable Armbina kernal upgrades |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#S01) | Ref or doc Needed |
+| S02 | Disable Armbina kernal upgrades |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#S02) | Ref or doc Needed |
+| S03 | Edit the boot enviroment (WIP) |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#S03) | Ref or doc Needed |
 
 
 ## Network
@@ -62,15 +62,15 @@ Wireless, Ethernet, and Network settings
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| N00 | Manage wifi network connections |  | X | X | Ref or doc Needed |
-| BT0 | Install Bluetooth support |  | X | X | Ref or doc Needed |
-| BT1 | Remove Bluetooth support |  | X | X | Ref or doc Needed |
-| BT3 | Bluetooth Discover |  | X | X | Ref or doc Needed |
-| IR1 | Remove Infrared support |  | [Reference](./README.md#L#30) | X | Ref or doc Needed |
-| IR0 | Install Infrared support |  | X | X | Ref or doc Needed |
-| N05 | Advanced Edit /etc/network/interface |  | X | X | Ref or doc Needed |
-| N06 | Disconect and forget all wifi connections (Advanced) |  | X | X | Ref or doc Needed |
-| N07 | Enable system |  | X | X | Ref or doc Needed |
+| N00 | Manage wifi network connections |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#N00) | Ref or doc Needed |
+| BT0 | Install Bluetooth support |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#BT0) | Ref or doc Needed |
+| BT1 | Remove Bluetooth support |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#BT1) | Ref or doc Needed |
+| BT3 | Bluetooth Discover |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#BT3) | Ref or doc Needed |
+| IR1 | Remove Infrared support |  | [Reference](./README.md#L#30) | [wiki](https://github.com/Tearran/configng/wiki/menu#IR1) | Ref or doc Needed |
+| IR0 | Install Infrared support |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#IR0) | Ref or doc Needed |
+| N05 | Advanced Edit /etc/network/interface |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#N05) | Ref or doc Needed |
+| N06 | Disconect and forget all wifi connections (Advanced) |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#N06) | Ref or doc Needed |
+| N07 | Enable system |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#N07) | Ref or doc Needed |
 
 
 ## Localisation
@@ -79,10 +79,10 @@ Localisation
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| L00 | Change Globla timezone (WIP) |  | X | X | Ref or doc Needed |
-| L01 | Change Locales reconfigure the language environment |  | X | X | Ref or doc Needed |
-| L02 | Change Keyboard layout |  | X | X | Ref or doc Needed |
-| L03 | Change APT mirrors |  | X | X | Ref or doc Needed |
+| L00 | Change Globla timezone (WIP) |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#L00) | Ref or doc Needed |
+| L01 | Change Locales reconfigure the language environment |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#L01) | Ref or doc Needed |
+| L02 | Change Keyboard layout |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#L02) | Ref or doc Needed |
+| L03 | Change APT mirrors |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#L03) | Ref or doc Needed |
 
 
 ## Software
@@ -91,8 +91,8 @@ Run/Install 3rd party apllications
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| I00 | Update Application Repository |  | X | X | Ref or doc Needed |
-| I01 | CLI System Monitor |  | X | X | Ref or doc Needed |
+| I00 | Update Application Repository |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#I00) | Ref or doc Needed |
+| I01 | CLI System Monitor |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#I01) | Ref or doc Needed |
 
 
 ## Downloads
@@ -101,7 +101,7 @@ Run/Download 3rd party apllications
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| D00 | CLI System Monitor |  | X | X | Ref or doc Needed |
+| D00 | CLI System Monitor |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#D00) | Ref or doc Needed |
 
 
 ## Development
@@ -110,10 +110,10 @@ Prosedures Testing grounds (WIP)
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| T00 | Chack if apt up to date (beta) | Tearran | X | X | Ref or doc Needed |
-| T01 | Remove kernel headers |  | X | X | Ref or doc Needed |
-| T02 | Install kernel headers |  | X | X | Ref or doc Needed |
-| T03 | System sensors |  | X | X | Ref or doc Needed |
+| T00 | Chack if apt up to date (beta) | Tearran | X | [wiki](https://github.com/Tearran/configng/wiki/menu#T00) | Ref or doc Needed |
+| T01 | Remove kernel headers |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#T01) | Ref or doc Needed |
+| T02 | Install kernel headers |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#T02) | Ref or doc Needed |
+| T03 | System sensors |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#T03) | Ref or doc Needed |
 
 
 ## Help
@@ -122,8 +122,8 @@ About this app
 
 | Job ID | Description | Contributor | Reference | Documents | Status |
 |:------ | ----------- | ----------- | --------- | --------- | ------:|
-| H00 | About This systme. (WIP) |  | X | X | Ref or doc Needed |
-| H02 | List of Config function(WIP) |  | X | X | Ref or doc Needed |
+| H00 | About This systme. (WIP) |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#H00) | Ref or doc Needed |
+| H02 | List of Config function(WIP) |  | X | [wiki](https://github.com/Tearran/configng/wiki/menu#H02) | Ref or doc Needed |
 
 ***
 ## Note:

diff --git a/config.ng.docs.sh b/config.ng.docs.sh
@@ -14,7 +14,7 @@ module_options+=(
 #
 # Function to generate the README.md file
 #
-generate_readme() {
+function generate_readme() {
 
     # Get the current date
     local current_date=$(date)  
@@ -184,7 +184,7 @@ module_options+=(
 #
 # Function to generate a JSON-like object file
 #
-generate_json_options() {
+function generate_json_options() {
     echo -e "{\n\"configng-helpers\" : ["
 features=()
 for key in "${!module_options[@]}"; do
@@ -238,7 +238,7 @@ module_options+=(
 #
 # This function is used to generate a armbian CPU logo
 #
-generate_svg(){
+function generate_svg(){
 
 cat << EOF
 <svg xmlns="http://www.w3.org/2000/svg" width="256" height="256" viewBox="0 0 300 300">
@@ -293,7 +293,7 @@ do
 
         # Check if src_reference and doc_link are null
         if [ "$src_reference" == "" ]; then src_reference="X"; else src_reference="[Reference]($src_reference)"; fi
-        if [ "$doc_link" == "" ]; then doc_link="X"; else doc_link="[Document]($doc_link)"; fi
+        if [ "$doc_link" == "" ]; then doc_link="[wiki](https://github.com/Tearran/configng/wiki/menu#$id)"; else doc_link="[Document]($doc_link)"; fi
 
         echo -e "| $id | $description | $author | $src_reference | $doc_link | Ref or doc Needed |"
 

diff --git a/config.ng.runtime.user.sh b/config.ng.runtime.user.sh
@@ -10,6 +10,7 @@ set_colors 0
 json_data=$(echo "$json_data" | jq --arg str "$localisation" '(.menu[] | select(.id == "Personalisation"   ) .description) += " (" + $str + ")"')
 json_data=$(echo "$json_data" | jq --arg str "$install" '(.menu[] | select(.id == "Downloads"   ) .description) += " (" + $str + ")"')
 
+
 #
 # Append Items to Sub menu descriptions 
 json_data=$(echo "$json_data" | jq --arg str "$network" '(.menu[] | select(.id=="Development").sub[] | select(.id == "T2").description) += " (" + $str + ")"')
@@ -25,6 +26,7 @@ json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Install") .show) |=
 json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Network") .show) |= false') ;
 json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Software") .show) |= false') ;
 
+
 #
 # show menu user level menu items
 json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Personalisation") .show) |= true') ;
@@ -34,14 +36,8 @@ json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Downloads") .show) |
 
 case "$1" in
     "--dev")
-    get_user_continue "User Mode:\n\nSystem Administration features unavalible\nWould you like to Continue?" process_input ;
-    json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Development") .show) |= true') ;
-    ;;
-
-    "--gui")
-        # Desktop keyboard job
-        desktop_keyboard
-        exit 0
+        get_user_continue "User Mode:\n\nSystem Administration features unavalible\nWould you like to Continue?" process_input ;
+        json_data=$(echo "$json_data" | jq '(.menu[] | select(.id=="Development") .show) |= true') ;
         ;;
     "--json")
         # Generate the EXAMPLES.md file from json job
@@ -60,7 +56,7 @@ case "$1" in
         see_use
         exit 0
         ;;
-        *)
+    *)
         get_user_continue "User Mode:\n\nSystem Administration features unavalible\nWould you like to Continue?" process_input ;
         ;;
 esac