add documenter for top level

.github/workflows/documentation.yml

@@ -8,7 +8,17 @@ on:
   pull_request:
   workflow_dispatch:
 
-jobs:   
+jobs:
+  call-documenter-XmlStructTools:
+    permissions:
+      contents: write
+      pull-requests: read
+      statuses: write
+    uses: ./.github/workflows/subdirdocumenter.yml
+    with:
+      subdir: .
+    secrets:
+      DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
   call-documenter-AbstractXsdTypes:
     permissions:
       contents: write

README.md

@@ -1,5 +1,7 @@
 # XmlStructTools.jl
 
+[![Dev Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://tom-lemmens.github.io/XmlStructTools.jl/dev/)
+
 The tools in XmlStructTools.jl aim to fill the role of schema based XML data binding in Julia.
 The functionality is split up into four packages:
 

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+Manifest.toml

docs/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "1.4"

docs/make.jl

@@ -0,0 +1,13 @@
+using Documenter
+
+repo = Remotes.GitHub("Tom-Lemmens", "XmlStructTools.jl")
+
+makedocs(;
+    repo = repo,
+    sitename = "XmlStructTools.jl",
+    pages = ["Home" => "index.md"],
+)
+
+deploydocs(
+    repo="github.com/$(repo.user)/$(repo.repo)",
+)

docs/src/index.md

@@ -0,0 +1,20 @@
+# XmlStructTools.jl
+
+The tools in XmlStructTools.jl aim to fill the role of schema based XML data binding in Julia.
+The functionality is split up into four packages:
+
+- XsdToStruct.jl can generate Julia struct definitions from XSD files.
+- AbstractXsdTypes.jl contains the shared functionality that is common between different XSD struct types.
+- XmlStructLoader.jl can use the module generated by AbstractXsdTypes.jl to validate and load XML files into the
+generated struct definitions.
+- XmlStructWriter.jl can write XSD struct instances to valid XML files.
+
+For a quick introduction you can watch [XML Data and Julian Types](https://www.youtube.com/watch?v=Z7qgOBNk-to)
+from JuliaCon Local Eindhoven 2023 to get a quick introduction to these packages.
+
+**Warning**
+These packages are still a work in progress.
+Only a small part of the entire W3C XSD recommendation is implemented.
+There are already some known bugs and a fix for them is on its way.
+But since this fix was developed at ASML this will take some time to go through the proper reviews.
+Please be patient while we get this sorted out.