Skip to content

Commit

Permalink
chore: publish docs on merge
Browse files Browse the repository at this point in the history
We don't need to publish the documentation as part of the PR; it can be done after we merge.

The `GH_TOKEN` variable is also set to a personal access token that should have permission to push
to the repository.

There is a small change in the documentation that removes a typo. It was used to test the process.
  • Loading branch information
jacderida committed Jan 3, 2025
1 parent 0888f97 commit 5eab134
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ on:
push:
branches:
- main
- data_further_refactor
pull_request:
branches:
- main

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 "[email protected]"
mkdocs gh-deploy --force
mkdocs gh-deploy --force
2 changes: 1 addition & 1 deletion docs/online-documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 5eab134

Please sign in to comment.