From 20bd223fcad2d16eb5ffdbbcbd5a29b029c84da9 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:07:51 +0100 Subject: [PATCH 1/7] Create linkcheck.yml --- .github/workflows/linkcheck.yml | 40 +++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/workflows/linkcheck.yml diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml new file mode 100644 index 00000000000..5634acb9c55 --- /dev/null +++ b/.github/workflows/linkcheck.yml @@ -0,0 +1,40 @@ +# .github/workflows/run-htmltest.yml +# (c) 2021 Robb Romans +# +# Run htmltest link checker on generated HTML output in dist/ +# https://github.com/wjdp/htmltest +# +name: run-htmltest-external +concurrency: + group: pullrequest-untrusted-htmltest-${{ github.event.number }} + cancel-in-progress: true +on: pull_request +jobs: + htmltest: + runs-on: ubuntu-large + container: + image: ghcr.io/cirruslabs/flutter:latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Setup Flutter + run: flutter pub get + + - name: Generate docs + run: dart doc + + - name: Test HTML + # https://github.com/wjdp/htmltest-action/ + # Don't fail the build on broken links + continue-on-error: false + uses: wjdp/htmltest-action@master + with: + config: .htmltest-local.yml + - name: Archive htmltest results + uses: actions/upload-artifact@v3 + # Note: Set ACTIONS_RUNTIME_TOKEN env variable to test with nektos/act + with: + name: htmltest-report + path: tmp/.htmltest/htmltest.log + retention-days: 7 # Default is 90 days From f6353e70cc0eb4fa8e661a158b8ee9696056e384 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:09:04 +0100 Subject: [PATCH 2/7] Add .htmltest --- .htmltest | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .htmltest diff --git a/.htmltest b/.htmltest new file mode 100644 index 00000000000..5f90672c238 --- /dev/null +++ b/.htmltest @@ -0,0 +1,11 @@ +DirectoryPath: "dist" +EnforceHTTPS: true +IgnoreEmptyHref: true +IgnoreInternalEmptyHash: true +IgnoreDirectoryMissingTrailingSlash: false +IgnoreURLs: + - "app.viam.com" +IgnoreDirs: + - "lib" +CacheExpires: "6h" +# IgnoreDirs: - if we need to ever ignore files \ No newline at end of file From 7dd0c784f8caa8b6039160873225c2480defc6b7 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:12:18 +0100 Subject: [PATCH 3/7] Update .github/workflows/linkcheck.yml --- .github/workflows/linkcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml index 5634acb9c55..b203a4b6ef8 100644 --- a/.github/workflows/linkcheck.yml +++ b/.github/workflows/linkcheck.yml @@ -30,7 +30,7 @@ jobs: continue-on-error: false uses: wjdp/htmltest-action@master with: - config: .htmltest-local.yml + config: .htmltest.yml - name: Archive htmltest results uses: actions/upload-artifact@v3 # Note: Set ACTIONS_RUNTIME_TOKEN env variable to test with nektos/act From e3a73dd4b5c3f9e49084f683d33a04a5d1563ad3 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:12:52 +0100 Subject: [PATCH 4/7] Rename .htmltest --- .htmltest => .htmltest.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .htmltest => .htmltest.yml (100%) diff --git a/.htmltest b/.htmltest.yml similarity index 100% rename from .htmltest rename to .htmltest.yml From deb68d8e7f0e51479b86afbce3c67831743d27fc Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:15:10 +0100 Subject: [PATCH 5/7] Update .htmltest.yml --- .htmltest.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.htmltest.yml b/.htmltest.yml index 5f90672c238..2626181b347 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -1,4 +1,4 @@ -DirectoryPath: "dist" +DirectoryPath: "doc/api" EnforceHTTPS: true IgnoreEmptyHref: true IgnoreInternalEmptyHash: true From 1fa145c6a28412067ad4b11cca3fc0e598561f08 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 20:20:50 +0100 Subject: [PATCH 6/7] Update .htmltest.yml --- .htmltest.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.htmltest.yml b/.htmltest.yml index 2626181b347..852c8e42d2c 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -5,6 +5,7 @@ IgnoreInternalEmptyHash: true IgnoreDirectoryMissingTrailingSlash: false IgnoreURLs: - "app.viam.com" + - "fonts.gstatic.com" IgnoreDirs: - "lib" CacheExpires: "6h" From 59f1e8a8cc029a2f4e198318102af99645da46ee Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Tue, 18 Jun 2024 21:27:36 +0100 Subject: [PATCH 7/7] Fix one link --- .htmltest.yml | 4 +++- lib/src/gen/app/v1/robot.pb.dart | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.htmltest.yml b/.htmltest.yml index 852c8e42d2c..16c6fb4e75f 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -9,4 +9,6 @@ IgnoreURLs: IgnoreDirs: - "lib" CacheExpires: "6h" -# IgnoreDirs: - if we need to ever ignore files \ No newline at end of file +# IgnoreDirs: - if we need to ever ignore files +CheckInternal: false +CheckDoctype: false \ No newline at end of file diff --git a/lib/src/gen/app/v1/robot.pb.dart b/lib/src/gen/app/v1/robot.pb.dart index c18864b8aa5..ce869b9be7b 100644 --- a/lib/src/gen/app/v1/robot.pb.dart +++ b/lib/src/gen/app/v1/robot.pb.dart @@ -1993,7 +1993,7 @@ class Orientation_EulerAngles extends $pb.GeneratedMessage { void clearYaw() => clearField(3); } -/// See here for a thorough explanation: https://en.wikipedia.org/wiki/Axis%E2%80%93angle_representation +/// See here for a thorough explanation: https://en.wikipedia.org/wiki/Axis-angle_representation /// Basic explanation: Imagine a 3d cartesian grid centered at 0,0,0, and a sphere of radius 1 centered at /// that same point. An orientation can be expressed by first specifying an axis, i.e. a line from the origin /// to a point on that sphere, represented by (rx, ry, rz), and a rotation around that axis, theta.