docs: add getting started guide (#98)

* move images

* add getting started docs

* move assets

* add how to notes

* add installation instructions

* rename site

docs/make.jl

@@ -4,10 +4,11 @@ makedocs(;
     modules=[AwkwardArray],
     format = Documenter.HTML(
         prettyurls = get(ENV, "CI", nothing) == "true",
-        assets=String["img/logo-300px.ico"],
+        assets=["assets/logo-300px.ico"],
     ),
     pages=[
         "Introduction" => "index.md",
+        "Getting started" => "getting_started.md",
         "Converting Arrays" => "exampleusage.md",
         "API" => Any[
             "Types" => "types.md",
@@ -16,10 +17,11 @@ makedocs(;
             hide("Internals" => "internals.md"),
         ],
         hide("Reference Guide" => "api.md"),
+        hide("HowTo" => "howto.md"),
         "LICENSE" => "LICENSE.md",
     ],
     repo="https://github.com/JuliaHEP/AwkwardArray.jl/blob/{commit}{path}#L{line}",
-    sitename="AwkwardArray.jl",
+    sitename="for Julia!",
     authors="Jim Pivarski, Jerry Ling, and contributors",
 )
 

docs/src/exampleusage.md

@@ -25,7 +25,6 @@ installed by the [CondaPkg.jl](https://github.com/JuliaPy/CondaPkg.jl) package.
 
 ```julia
 using CondaPkg
-CondaPkg.add("numpy")
 CondaPkg.add("awkward")
 ```
 

docs/src/getting_started.md

@@ -0,0 +1,49 @@
+# Getting started
+
+Let's assume that both Python and Julia are installed.
+
+## Installation
+
+It is recommended to use [conda](https://conda.io/projects/conda/en/latest/user-guide/getting-started.html) virtul environment.
+
+## Using Julia Awkward Arrays from Python
+
+ - To install [Awkward Array](https://github.com/scikit-hep/awkward) Python package:
+
+```python
+conda install -c conda-forge awkward
+```
+ - To install [JuliaCall](https://juliapy.github.io/PythonCall.jl):
+
+```python
+conda install pyjuliacall
+```
+JuliaCall takes care of installing all necessary Julia packages, including this package. 
+
+```python
+import awkward as ak
+from juliacall import Main as jl
+
+jl.seval("using AwkwardArray")
+```
+
+## Using Python Awkward Arrays from Julia
+
+[PythonCall](https://github.com/JuliaPy/PythonCall.jl) is currently configured to use the Julia-specific Python distribution
+installed by the [CondaPkg.jl](https://github.com/JuliaPy/CondaPkg.jl) package.
+
+```julia
+using CondaPkg
+CondaPkg.add("awkward")
+```
+
+```julia
+using PythonCall
+
+const ak = pyimport("awkward")
+
+println(ak.__version__)
+2.6.4
+```
+
+See [Examples](@ref).

docs/src/howto.md

@@ -0,0 +1,5 @@
+# How to build documentation locally
+
+```julia
+julia --project=docs/  docs/make.jl
+```