Merge pull request #89 from HCMID/dev

Update docs

docs/make.jl

@@ -17,12 +17,7 @@ makedocs(
     sitename = "Orthography",
     pages = [
         "Orthography.jl" => "index.md",
-
-        "API documentation" => [
-            "man/index.md",
-            "man/internals.md"
-        ]
-    ]
+      ]
     )
 
 deploydocs(

docs/src/index.md

@@ -1,4 +1,4 @@
 # Orthography
 
 
-Learn the package on quarto.pub.  See API docs here.
+Documentation has moved to [quarto.pub](https://neelsmith.quarto.pub/orthography/).

quarto/_quarto.yml

@@ -5,7 +5,7 @@ theme: spacelab
 execute:
   freeze: auto
 date: last-modified  
-margin-header: "⚠️ *Draft release.*"
+margin-header: "⚠️ *Draft documentation in progress:*<br/>Package version `0.22.0`."
 format:
   html: 
     toc: true
@@ -26,6 +26,7 @@ website:
 
       - text: "Guides"
         file: guides/index.qmd           
+
       - text: "Reference"
         file: reference/index.qmd  
       - text: "Acknowledgments"
@@ -34,6 +35,13 @@ website:
       - icon: github
         href: https://github.com/hcmid/Orthography.jl
         aria-label: GitHub
+      - icon: person-circle
+        menu:
+          - text: "About me"
+            href: https://neelsmith.quarto.pub
+          - text: "More of my digital scholarship"
+            href: https://neelsmith.quarto.pub/digschol/
+        aria-label: "More of my work"         
 
   sidebar:
     - title: "Concepts"
@@ -43,20 +51,25 @@ website:
     - title: "Tutorials"
       contents: 
         - tutorials/index.qmd
+        - text: "---"           
         - tutorials/validation.qmd
         - tutorials/tokenization.qmd
         - tutorials/corpora.qmd
 
     - title: "Guides"
       contents:
         - guides/index.qmd
+        - text: "---"   
         - guides/tokenization-guide.qmd
         - guides/diyortho.qmd
 
     - title: "Reference"
       contents: 
         - reference/index.qmd
-        - reference/implementations.qmd
+        - reference/apis.qmd
+        - reference/internals.qmd
+
+
 
 
 

quarto/guides/index.qmd

@@ -2,4 +2,11 @@
 title: "Guides"
 ---
 
-Recipe book for working with `Orthography.jl`
+If you're just getting started with `Orthography.jl`, 
+
+:::{.callout-warning}
+
+Recipes for working with the `Orthography.jl` package.
+:::
+
+

quarto/index.qmd

@@ -7,4 +7,3 @@ This site introduces the conceptual model of orthography developed over several
 
 It also includes documentation of `Orthography.jl`, a Julia package that implements the MID model of orthography. `Orthography.jl` supports working with editions of digital texts adhering to a specified orthography.
 
-

quarto/reference/apis.qmd

@@ -0,0 +1,165 @@
+# Exported types and functions
+
+## Types
+
+
+`OrthographicSystem`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+using Orthography
+@doc OrthographicSystem
+```
+:::
+
+`TokenCategory`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc TokenCategory
+```
+:::
+
+`LexicalToken`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc LexicalToken
+```
+:::
+
+
+`NumericToken`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc NumericToken
+```
+:::
+
+
+`PunctuationToken`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc PunctuationToken
+```
+:::
+
+## Functions
+
+Public functions implemented for all subtypes of `OrthographicSystem`.
+
+
+
+`codepoints`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc PunctuationToken
+```
+:::
+
+
+`tokentypes`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc tokentypes
+```
+:::
+
+`validcp`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc validcp
+```
+:::
+
+`validstring`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc validstring
+```
+:::
+
+`tokenize`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc tokenize
+```
+:::
+
+Working with text corpora:
+
+
+`corpus_histo`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc corpus_histo
+```
+:::
+
+Other utilities
+
+
+`nfkc`
+
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc nfkc
+```
+:::
+
+## Example implementation
+
+
+`SimpleAscii`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc SimpleAscii
+```
+:::
+
+`simpleAscii`
+
+:::{.callout-note appearance="minimal"}
+```{julia}
+#| echo: false
+#| warning: false
+@doc simpleAscii
+```
+:::
+

quarto/reference/index.qmd

@@ -3,4 +3,19 @@ title: Reference
 ---
 
 
-Current API docs for the `Orthography.jl` package are on github at [https://hcmid.github.io/Orthography.jl/stable/](https://hcmid.github.io/Orthography.jl/stable/).
+## API documentation
+
+- [exported types and functions](./apis.qmd)
+- [internal functions](./internals.qmd)
+
+## Implementations
+
+The following Julia packages available from the Julia central registry implement one or more concrete subtypes of the `OrthographicSystem` abstraction.
+
+- `LatinOrthography.jl`
+- `PolytonicGreek.jl`
+- `ManuscriptOrthography.jl` (Greek)
+- `GreekScientificOrthography.jl`
+- `AtticGreek.jl`
+- `Lycian.jl`
+- `BiblicalHebrew.jl`