From 0710e319dc296c698f6ccafb8e5ad6350cc34209 Mon Sep 17 00:00:00 2001 From: George Dietrich Date: Fri, 29 Jan 2021 22:32:41 -0500 Subject: [PATCH] Finish porting docs to mkdocs --- .github/workflows/deployment.yml | 27 --------------------------- README.md | 3 ++- shard.yml | 4 ++-- 3 files changed, 4 insertions(+), 30 deletions(-) delete mode 100644 .github/workflows/deployment.yml diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml deleted file mode 100644 index 095862e..0000000 --- a/.github/workflows/deployment.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Deployment - -on: - push: - branches: - - master - -jobs: - deploy_docs: - runs-on: ubuntu-latest - container: - image: crystallang/crystal:latest-alpine - steps: - - name: Install Build Dependencies - run: apk add --update rsync - - uses: actions/checkout@v2 - - name: Install Dependencies - run: shards install - - name: Build - run: crystal docs lib/athena-spec/src/athena-spec.cr src/athena-negotiation.cr - - name: Deploy - uses: JamesIves/github-pages-deploy-action@3.7.1 - with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages - FOLDER: docs - SINGLE_COMMIT: true diff --git a/README.md b/README.md index eb8264a..1f7b4fd 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ dependencies: ## Documentation -Everything is documented in the [API Docs](https://athena-framework.github.io/negotiation/Athena/Negotiation.html). +If using the component on its own, checkout the [API documentation](https://athenaframework.org/Negotiation). +If using the component as part of Athena, also checkout the [external documentation](https://athenaframework.org/components/negotiation). ## Contributing diff --git a/shard.yml b/shard.yml index 1f5a48e..63be182 100644 --- a/shard.yml +++ b/shard.yml @@ -1,6 +1,6 @@ name: athena-negotiation -version: 0.1.0 +version: 0.1.1 crystal: '>= 0.35.0' @@ -8,7 +8,7 @@ license: MIT repository: https://github.com/athena-framework/negotiation -documentation: https://athena-framework.github.io/negotiation/Athena/Negotiation.html +documentation: https://athenaframework.org/Negotiation description: | Framework agnostic content negotiation library.