Initial documentation development

AP6YC · Oct 14, 2020 · e8edfdf · e8edfdf
1 parent c2adabe
commit e8edfdf
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -13,6 +13,7 @@ Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DrWatson = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 MAT = "23992714-dd62-5051-b70f-ba57cb901cac"
 MLJ = "add582a8-e3ab-11e8-2d5e-e98b27df1bc7"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -21,12 +21,16 @@ Pages = [
 Depth = 1
 ```
 
+This is how you use the module manually.
+
 ## Library Outline
 
 ```@contents
 Pages = ["lib/public.md", "lib/internals.md"]
 ```
 
+This is how you develop the library.
+
 ### [Index](@id main-index)
 
 ```@index

diff --git a/docs/src/man/examples.md b/docs/src/man/examples.md
@@ -1,3 +1,11 @@
 # Examples
 
-Here are some helpful examples of the usage of the module.
+Here are some helpful examples of the usage of the module.
+
+## Example 1:
+
+asdf
+
+## Example 2:
+
+asdf
diff --git a/docs/src/man/guide.md b/docs/src/man/guide.md
@@ -13,4 +13,4 @@ Alternatively, it can be added to/ your environment in a script with
 ```julia
 using Pkg
 Pkg.add("AdaptiveResonance")
-```
+```