Merge pull request #44 from cite-architecture/dev

Complete refactoring of CITE abstractions

.github/workflows/Documentation.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@latest
         with:
-          version: '1.5'
+          version: '1.7'
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy

.gitignore

@@ -1,4 +1,6 @@
 Manifest.toml
 *.~
 docs/build/
-scratch/
+scratch/
+scratch*
+.vscode/

docs/make.jl

@@ -17,12 +17,9 @@ makedocs(
     sitename = "CitableBase.jl",
     pages = [
         "Home" => "index.md",
-        "URNs" => "urns.md",
-        "Citable resources" => "citable.md",
-        "Citable trait" => "citabletrait.md",
-        "URN comparison" => "urncomparison.md",
-        "CEX serialization" => "cex.md",
-        "Implementations" => "implementations.md",
+        "Identifiers" => "urns.md",
+        "Citable objects" => "citable.md",
+        "Citable collections" => "collections.md",
         "API documentation" => "apis.md"
     ]
     )

docs/src/apis.md

@@ -8,17 +8,8 @@ CurrentModule = CitableBase
 
 ```@docs
 Urn
-```
-
-Concrete functions for Urns
-
-```@docs
 components
 parts
-```
-URN abstractions to implement for specific types
-
-```@docs
 addversion
 dropversion
 ```
@@ -28,12 +19,10 @@ dropversion
 
 ```@docs
 Citable
-```
-
-Functions to implement for citable resources:
-
-
-```@docs
+CitableTrait
+NotCitable
+citabletrait
+citable
 urn
 label
 ```
@@ -43,6 +32,10 @@ label
 
 ```@docs
 UrnComparisonTrait
+NotUrnComparable
+urncomparisontrait
+urncomparable
+urnequals
 urncontains
 urnsimilar
 ```
@@ -53,6 +46,21 @@ urnsimilar
 
 ```@docs
 CexTrait
+NotCexSerializable
+cextrait
+cexserializable
 cex
 fromcex
+```
+
+
+
+
+## Citable collections
+
+```@docs
+CitableCollectionTrait
+NotCitableCollection
+citablecollectiontrait
+citablecollection
 ```