docs: fix dead links and CI - #1981
Conversation
Signed-off-by: Nick Schonning <nschonni@gmail.com>
Signed-off-by: Nick Schonning <nschonni@gmail.com>
Signed-off-by: Nick Schonning <nschonni@gmail.com>
Signed-off-by: Nick Schonning <nschonni@gmail.com>
| VMC, or Vector Magnitude Counts, is a measure of the overall amount of movement in the watch over time. When the watch is perfectly still, the VMC will be 0 and greater amounts of movement result in higher VMC numbers. Running, for example results in a higher VMC than walking. | ||
|
|
||
| The VMC computation in Pebble Health was developed in conjunction with the Stanford Wearables lab and has been calibrated to match the VMC numbers produced by the [Actigraph](http://www.actigraphcorp.com/product-category/activity-monitors/) wrist-worn device. The Actigraph is commonly used today for medical research studies. The Stanford Wearables lab will be publishing the VMC computation used in the Pebble Health algorithm and this transparency of the algorithm will enable the Pebble to be used for medical research studies as well. | ||
| The VMC computation in Pebble Health was developed in conjunction with the Stanford Wearables lab and has been calibrated to match the VMC numbers produced by the [Actigraph](https://ametris.com/actigraph-leap) wrist-worn device. The Actigraph is commonly used today for medical research studies. The Stanford Wearables lab will be publishing the VMC computation used in the Pebble Health algorithm and this transparency of the algorithm will enable the Pebble to be used for medical research studies as well. |
There was a problem hiding this comment.
Not sure if it's better to drop the link, but from the redirect to the new domain, this seemed closest to what was described
| pull_request: | ||
| paths: | ||
| - .github/workflows/docs-linkcheck.yml | ||
| - docs/ |
There was a problem hiding this comment.
this is a bad idea, urls accessibility can be flaky, causing noisy CI, better do it offline and periodically fix
There was a problem hiding this comment.
Your call, but this will still only run if a particular PR touches on of the docs files, so it wouldn't cause most of the PRs to even run. I guess some of your recent work has touched the folder though https://github.com/coredevices/PebbleOS/commits/main/docs
There was a problem hiding this comment.
It can still be noisy (from my experience in other projects). Just checking: will this check all links?
There was a problem hiding this comment.
I think it's just the ones inside the docs folder, but I think that might glob in the CONTRIBUTING.md at the root too.
|
@gmarull if you'd prefer to cherry pick or just redo the parts you like in your own PR, I'm fine with that too. |
Signed-off-by: Nick Schonning <nschonni@gmail.com>
|
@gmarull I took a look around again to see if I could find something else around your concerns with making other PRs flaky. I did see other complaining about the particular sphinx one, so I gave lychee a try. You can see the issue it spun up here nschonni#1 and the workflow (copied from their example here https://github.com/nschonni/PebbleOS/actions/runs/33970591733/workflow) |
2 participants
Noticed this since I got a build failure on my fork. Originally was going to filter the job, but decided to just fix the link and make sure any PR that touches the docs runs the CI.
Could add a badge to the README for visibility, but I didn't think that would be too helpful in catching the failing job.