selkies-project / selkies-gstreamer

Open-Source Low-Latency Accelerated Linux WebRTC HTML5 Remote Desktop Streaming Platform for Self-Hosting, Containers, Kubernetes, or Cloud/HPC
https://selkies-project.github.io/selkies-gstreamer/
Mozilla Public License 2.0
380 stars 48 forks source link

📝 added documentation using mkdocs #166

Closed vishalkadam47 closed 3 weeks ago

vishalkadam47 commented 2 months ago

Documentation using MkDocs

here's a quick deployment using cloudflare for review https://selkies-gstreamer.pages.dev/

I tried this :point_down: but I guess because of Pages on this forked repository is disabled I'm not able to deploy

name: docs
on:
  push:
    branches:
      - docs
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - run: pip install mkdocs-material
      - run: mkdocs gh-deploy --force
ehfd commented 3 weeks ago

Refactored and superseded by https://github.com/selkies-project/selkies-gstreamer/commit/0989204f5243b6ae13170791825ebace9653a975

@vishalkadam47 @PMohanJ Both of you were credited in the commit. Thank you all.