Skip to content

Commit

Permalink
chore: publish documentation after merge
Browse files Browse the repository at this point in the history
We should not need to publish the documentation on the PR, but rather, after it is merged.

I also changed a few little things in the documentation so that I could test the publish.
  • Loading branch information
jacderida committed Jan 3, 2025
1 parent 0888f97 commit 99c4c98
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
10 changes: 4 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@ name: Deploy Documentation
on:
push:
branches:
- main
- data_further_refactor
pull_request:
branches:
- main
- chore-publish_docs

permissions:
contents: write

jobs:
deploy:
env:
GH_TOKEN: ${{ secrets.AUTONOMI_PAT }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -33,4 +31,4 @@ jobs:
run: |
git config --global user.name "github-actions"
git config --global user.email "github-actions@github.com"
mkdocs gh-deploy --force
mkdocs gh-deploy --force
4 changes: 2 additions & 2 deletions docs/online-documentation/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Autonomi Documentation

Welcome to the Autonomi documentation! This guide will help you get started with using the Autonomi network client.
Welcome to the Autonomi documentation! This guide will help you get started using the Autonomi network client.

## What is Autonomi?

Expand All @@ -13,7 +13,7 @@ Autonomi is a decentralised data and communications platform designed to provide
- [Data Types](guides/data_types.md) - Understanding the fundamental data structures
- [Client Modes](guides/client_modes.md) - Different operational modes of the client
- [Data Storage](guides/data_storage.md) - How data is stored and retrieved
- [Local Network Setup](guides/local_network.md) - Setting up a local development environmentv
- [Local Network Setup](guides/local_network.md) - Setting up a local development environment

### API References

Expand Down

0 comments on commit 99c4c98

Please sign in to comment.