Finish porting docs to mkdocs (#14)

athena-framework · Jan 30, 2021 · f7829ca · f7829ca
1 parent ca8e255
commit f7829ca
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 30 deletions.
diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml
diff --git a/README.md b/README.md
@@ -7,7 +7,8 @@ Flexible object (de)serialization library
 
 ## Documentation
 
-Everything is documented in the [API Docs](https://athena-framework.github.io/serializer/Athena/Serializer.html).
+If using the component on its own, checkout the [API documentation](https://athenaframework.org/Serializer).
+If using the component as part of Athena, also checkout the [external documentation](https://athenaframework.org/components/serializer).
 
 ## Contributing
 

diff --git a/shard.yml b/shard.yml
@@ -1,14 +1,14 @@
 name: athena-serializer
 
-version: 0.2.4
+version: 0.2.5
 
 crystal: '>= 0.35.0'
 
 license: MIT
 
 repository: https://github.com/athena-framework/serializer
 
-documentation: https://athena-framework.github.io/serializer/Athena/Serializer.html
+documentation: https://athenaframework.org/Serializer
 
 description: |
   Object (de)serialization library.