Docs rework (#21)

* wip

* docs reworked

* reworked docs

* updated docs and pipeline

---------

Co-authored-by: ex61wi <tim.rorije@ing.com>
Co-authored-by: dutchie032 <dutchie032>

classes/api/SpearheadApi.lua

@@ -0,0 +1,55 @@
+
+
+
+
+
+local SpearheadAPI = {}
+do
+
+    SpearheadAPI.Stages = {}
+
+    --- Changes the active stage of spearhead.
+    --- All other stages will change based on the normal logic. (CAP, BLUE etc.)
+    --- @param stageNumber number the stage number you want changed
+    --- @return boolean success indicator of success
+    --- @return string message error message
+    SpearheadAPI.Stages.changeStage = function(stageNumber) 
+        if type(stageNumber) ~= "number" then
+            return false, "stageNumber " .. stageNumber .. " is not a valid number"
+        end
+
+        Spearhead.Events.PublishStageNumberChanged(stageNumber)
+        return true, ""
+    end
+
+    ---Returns the current stange number
+    ---Returns nil when the stagenumber was not set before ever, which means Spearhead was not started.
+    ---@return number | nil
+    SpearheadAPI.Stages.getCurrentStage = function()
+        return Spearhead.StageNumber or nil
+    end
+
+    ---returns whether a stage (by index) is complete. 
+    ---@param stageNumber number
+    ---@return boolean | nil
+    ---@return string 
+    SpearheadAPI.isStageComplete = function(stageNumber)
+        if type(stageNumber) ~= "number" then
+            return false, "stageNumber " .. stageNumber .. " is not a valid number"
+        end
+
+        local isComplete = Spearhead.internal.GlobalStageManager.isStageComplete(stageNumber)
+        if isComplete == nil then
+            return nil, "no stage found with number " .. stageNumber
+        end
+
+        return isComplete, ""
+    end
+
+end
+
+
+if Spearhead == nil then Spearhead = {} end
+Spearhead.API = SpearheadAPI
+
+