docs(user-guide): Mv tips to user-guide #4
This file contains hidden or 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: Publish docs via GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| # Only rebuild website when docs have changed | |
| - "README.md" | |
| - "deployment/**" | |
| - "docs/**" | |
| - "src/**" | |
| - ".github/workflows/deploy-mkdocs.yaml" | |
| jobs: | |
| build: | |
| name: Deploy docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout main | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| - uses: astral-sh/setup-uv@v4 | |
| with: | |
| enable-cache: true | |
| - name: Deploy docs | |
| run: uv run --extra docs mkdocs gh-deploy --force |