docs: add fabric crd docs from v0.71.6

[mrbojangles3]

closes https://github.com/githedgehog/internal/issues/122
Since @Frostman did the supported devices table

[github-actions]

🚀 Deployed on https://preview-99--hedgehog-docs.netlify.app

[mrbojangles3]

I am tempted to manual undo the formatting that creates the links to nowhere. But that isn't the right way to fix the problem.

[qmonnet]

Looks good, but I see that you skipped the doc update from githedgehog/fabric@efd6264, is it intentional?

[qmonnet]

I am tempted to manual undo the formatting that creates the links to nowhere. But that isn't the right way to fix the problem.

Yep, that's something we should ideally fix in the way we generate the doc; if there's no option to do that (I didn't manage to find one when looking this morning), then fallback on some additional generation step where we run some fix-up script, I guess.

[mrbojangles3]

That was unintentional. I guess we have another fabric bump and tag coming.

I took a quick look at it as well. I see places to exclude the field entirely from the docs, but we don't want to do that. I was thinking the other way to do it would be to add more info to the fabric repo so those links actually have a place to go.

[Frostman]

Good catch, it was changed after the release artifact

[qmonnet]

Would it make sense to automatically create PRs in this repo with a GH Action when we push a tag on the fabric repo?

[qmonnet]

Something like that in fabric:

name: Update docs

on:
  push:
    tags:
      - '*'

jobs:
  copy-api-reference:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout "fabric" repository
        uses: "actions/checkout@v4"
        with:
          fetch-depth: 0
          persist-credentials: "false"

      - name: Checkout "docs" repository
        uses: "actions/checkout@v4"
        with:
          repository: githedgehog/docs
          path: /documentation
          persist-credentials: "false"

      - name: Copy API reference from "fabric" to "docs"
        run: |
          cp docs/api.md /documentation/docs/reference/api.md

      - name: Create Pull Request
        uses: "peter-evans/create-pull-request@v7"
        with:
          token: ${{ secrets.DOCS_API_REF_UPDTATE_TOKEN }}
          path: /documentation
          commit-message: |
            Update API reference from ${{ github.repository }} tag ${{ github.ref_name }}.

            This is an automated commit created by GitHub Actions workflow,
            in the "${{ github.repository }}" repository.
          signoff: true
          title: "Update API reference from ${{ github.repository }} tag ${{ github.ref_name }}"
          body: |
            Update API reference from ${{ github.repository }} tag ${{ github.ref_name }}.

            This is an automated Pull Requesst created by GitHub Actions workflow,
            in the "${{ github.repository }}" repository.

(Not tested - And I don't think I have permission to create the relevant token.)

[qmonnet]

See githedgehog/fabric#822