Monorepo introduction and some fixes

.gitignore

@@ -11,7 +11,7 @@ LocalPreferences.toml
 .DS_Store
 docs/src/democards/gridtheme.css
 test.jl
-GNNGraphs/docs/build
-GNNlib/docs/build
-GNNLux/docs/build
-multidocs/build
+/GNNGraphs/docs/build/
+/GNNlib/docs/build/
+/GNNLux/docs/build/
+/multidocs/build/

GNNLux/docs/src/api/basic.md

@@ -3,6 +3,6 @@ CurrentModule = GNNLux
 ```
 
 ## GNNLayer
-
+```@docs
 GNNLux.GNNLayer
-
+```

GNNLux/docs/src/index.md

@@ -1 +1,5 @@
-Write GNNLux docs
+# GNNLux.jl 
+
+GNNLux.jl is a work-in-progress package that implements stateless graph convolutional layers, fully compatible with the [Lux.jl](https://lux.csail.mit.edu/stable/) machine learning framework. It is built on top of the GNNGraphs.jl, GNNlib.jl, and Lux.jl packages.
+
+The full documentation will be available soon.

docs/make.jl

@@ -21,10 +21,18 @@ makedocs(;
          plugins = [interlinks],
          format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
          sitename = "GraphNeuralNetworks.jl",
-         pages = ["Home" => "index.md",
-            "Models" => "models.md",
-            "Dev" => "dev.md",
-            "Gsoc" => "gsoc.md",
+         pages = ["Monorepo" => [ 
+               "Home" => "monorepo.md",
+               "Developer guide" => "dev.md",
+               "Google Summer of Code" => "gsoc.md",
+
+
+            ],
+            "GraphNeuralNetworks.jl" =>[
+            "Home" => "index.md",
+            "Models" => "models.md",],
+
+
 
             "API Reference" => [
 
@@ -36,7 +44,6 @@ makedocs(;
 
 
               ],
-            #  "Developer Notes" => "dev.md",
 
          ],
          )

docs/src/monorepo.md

@@ -0,0 +1,20 @@
+# GraphNeuralNetworks Monorepo
+
+This repository is a monorepo that contains all the code for the GraphNeuralNetworks project. The project is organized as a monorepo to facilitate code sharing and reusability across different components of the project. The monorepo contains the following packages:
+
+- `GraphNeuralNetwork.jl`: Package that contains stateful graph convolutional layers based on the machine learning framework [Flux.jl](https://fluxml.ai/Flux.jl/stable/). This is fronted package for Flux users. It depends on GNNlib.jl, GNNGraphs.jl, and Flux.jl packages.
+
+- `GNNLux.jl`: Package that contains stateless graph convolutional layers based on the machine learning framework [Lux.jl](https://lux.csail.mit.edu/stable/). This is fronted package for Lux users. It depends on GNNlib.jl, GNNGraphs.jl, and Lux.jl packages.
+
+- `GNNlib.jl`: Package that contains the core graph neural network layers and utilities. It depends on GNNGraphs.jl and GNNlib.jl packages and serves for code base for GraphNeuralNetwork.jl and GNNLux.jl packages.
+
+- `GNNGraphs.jl`: Package that contains the graph data structures and helper functions for working with graph data. It depends on Graphs.jl package.
+
+Here is a schema of the dependencies between the packages:
+
+![Monorepo schema](assets/schema.png)
+
+
+
+
+

multidocs/make-multi.jl

@@ -4,7 +4,7 @@ docs = [
     MultiDocumenter.MultiDocRef(
         upstream = joinpath(dirname(@__DIR__), "docs", "build"),
         path = "graphneuralnetworks",
-        name = "GraphNeuralNetworks.jl",
+        name = "GraphNeuralNetworks",
         fix_canonical_url = false),
     MultiDocumenter.MultiDocRef(
         upstream = joinpath(dirname(@__DIR__), "GNNGraphs", "docs", "build"),