📝 update md documentation + add auto-sync action #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Sync `documentation` directory to ReadMe | |
# Run workflow for every push to the `main` branch | |
on: | |
workflow_dispatch: | |
release: | |
branches: | |
- main | |
pull_request: | |
jobs: | |
sync: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout this repo | |
uses: actions/checkout@v4 | |
# Run GitHub Action to sync docs in `documentation` directory | |
- name: GitHub Action | |
uses: readmeio/rdme@v8 | |
with: | |
rdme: docs ./docs --key=${{ secrets.README_API_KEY }} --version=1.0 |