state machine docs re-add

Author: VigneshVSV

.gitignore

@@ -162,3 +162,4 @@ cython_debug/
 #.idea/
 
 skaffold.env
+TODO.md

docs/beginners-guide/articles/state-machine.md

@@ -1,56 +1,55 @@
-Using Finite State Machine
---------------------------
-
 [API Reference](../../api-reference/thing/state-machine.md)
 
-Often, certain operations are not allowed during certain conditions, for example, 
-one cannot turn ON a motor twice in a row, or one does not wish to change the 
+Often, certain operations are not allowed during certain conditions, for example,
+one cannot turn ON a motor twice in a row, or one does not wish to change the
 exposure of a camera during video capture (say).
 
-To implement these contraints, a state machine may be used to prevent property writes or 
-action invokations in certain states (events are not supported). A `StateMachine` is a class-level 
-attribute which accepts a finite list of states and the allowed properties and actions 
+To implement these contraints, a state machine may be used to prevent property writes or
+action invokations in certain states (events are not supported). A `StateMachine` is a class-level
+attribute which accepts a finite list of states and the allowed properties and actions
 in these states:
 
 ```py title="Definition" linenums="1"
---8<-- "docs/howto/code/fsm/def.py:1:1"
---8<-- "docs/howto/code/fsm/def.py:12:15"
---8<-- "docs/howto/code/fsm/def.py:34:36"
---8<-- "docs/howto/code/fsm/def.py:40:41"
-``` 
-   
-Specify the machine conditions as keyword arguments to the `state_machine` with properties and actions 
+--8<-- "docs/beginners-guide/code/fsm/def.py:1:1"
+--8<-- "docs/beginners-guide/code/fsm/def.py:12:15"
+--8<-- "docs/beginners-guide/code/fsm/def.py:34:36"
+--8<-- "docs/beginners-guide/code/fsm/def.py:40:41"
+```
+
+Specify the machine conditions as keyword arguments to the `state_machine` with properties and actions
 in a list:
 
 ```py title="Specify Properties and Actions" linenums="1"
---8<-- "docs/howto/code/fsm/def.py:1:2"
---8<-- "docs/howto/code/fsm/def.py:12:41"
+--8<-- "docs/beginners-guide/code/fsm/def.py:1:2"
+--8<-- "docs/beginners-guide/code/fsm/def.py:12:41"
 ```
 
 As expected, one needs to set the `StateMachine` state to indicate state changes:
 
 ```py title="set_state()" linenums="1"
---8<-- "docs/howto/code/fsm/def.py:13:15"
---8<-- "docs/howto/code/fsm/def.py:54:63"
+--8<-- "docs/beginners-guide/code/fsm/def.py:13:15"
+--8<-- "docs/beginners-guide/code/fsm/def.py:54:63"
 ```
 
 One can also sepcify the allowed state of a property or action directly
 on the corresponding objects:
 
 ```py title="Specify State Alternate" linenums="1"
---8<-- "docs/howto/code/fsm/def.py:13:15"
---8<-- "docs/howto/code/fsm/def.py:64:"
+--8<-- "docs/beginners-guide/code/fsm/def.py:13:15"
+--8<-- "docs/beginners-guide/code/fsm/def.py:64:"
 ```
 
 State machines also push state change event when the state changes:
 
 ```py title="Definition" linenums="1"
+
 ```
 
-One can suppress state change events by setting ``push_state_change_event=False``.
+One can suppress state change events by setting `push_state_change_event=False`.
 
-Lastly, one can also supply callbacks which are executed when entering and exiting certain states, 
+Lastly, one can also supply callbacks which are executed when entering and exiting certain states,
 irrespective of where or when the state change occured:
 
 ```py title="Definition" linenums="1"
-```
+
+```

docs/introduction/contributing.md

@@ -2,7 +2,7 @@
 
 We welcome contributions to `hololinked`! All types of contributions are encouraged and valued.
 
-> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> If you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
 >
 > - Star the project
 > - Tweet about it or share in social media
@@ -12,11 +12,11 @@ We welcome contributions to `hololinked`! All types of contributions are encoura
 
 You can contribute in the following ways:
 
-- Reporting bugs and issues
-- Suggesting new features
-- Improving documentation
-- Code
-- Submitting Examples or Implementations
+- reporting bugs and issues
+- submitting code
+- improving documentation
+- suggesting new features
+- submitting examples or implementations
 
 For good first issues, visit repository wise:
 

mkdocs.yml

@@ -22,11 +22,11 @@ nav:
       - Using Actions: beginners-guide/articles/actions.md
       - Using Events: beginners-guide/articles/events.md
       - Using State Machine: beginners-guide/articles/state-machine.md
-      - Configuring Thing Class:
-          - Thing: beginners-guide/articles/thing/index.md
-      - Using Different Protocols:
-          - Object Proxy: beginners-guide/articles/object-proxy.md
-      - Serialization: beginners-guide/articles/serialization.md
+      # - Configuring Thing Class:
+      #     - Thing: beginners-guide/articles/thing/index.md
+      # - Using Different Protocols:
+      #     - Object Proxy: beginners-guide/articles/object-proxy.md
+      # - Serialization: beginners-guide/articles/serialization.md
   # API Reference
   - API Reference:
       - Thing: