Code Monkey home page Code Monkey logo

watchy-docs's Introduction

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

watchy-docs's People

Contributors

aminch avatar b-bayport avatar bmsleight avatar cbrookins avatar charlesrocket avatar cqoicebordel avatar darigovresearch avatar dependabot[bot] avatar dezign999 avatar edent avatar ericlinagora avatar hiroshi avatar lazlow3 avatar leeholmes avatar lifton avatar mrvulcan68 avatar msgoodman avatar my-key avatar simonmicro avatar sqfmi avatar starptr avatar stuangel avatar sukhpalhub avatar synthead avatar t26y avatar titobotelho avatar tristanr-cogapp avatar ucbill avatar vojtech-bizek avatar vtu-dog avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

watchy-docs's Issues

Getting started documentation states "there is a bug in 2.0.3" in regards to esp32 without any context

On this line in the documentation...

4. Open **Boards Manager** under Tools > Board menu and install the *esp32* platform (Note: there is a bug in 2.0.3, please use 2.0.2 until it is fixed)

...it reads:

Note: there is a bug in 2.0.3, please use 2.0.2 until it is fixed

This is not very descriptive. What bug? How do we know if it's fixed? How do we know if we're encountering the bug? It'd be great to link to an issue with this text 👍

Multiple broken links on Watch Faces page

It looks like peerdavid's Watchy links are all broken on https://watchy.sqfmi.com/watchfaces:

  • Jarvis
    {
    "id" : "11",
    "name" : "Jarvis",
    "author" : "peerdavid",
    "screenshot" : "/img/watchfaces/11_Jarvis.gif",
    "source" : "https://github.com/peerdavid/Watchy/tree/master/examples/WatchFaces/David",
    "ota_bin" : false,
    "version" : "1.0.0"
    },
  • BTTF
    {
    "id" : "14",
    "name" : "BTTF",
    "author" : "peerdavid",
    "screenshot" : "/img/watchfaces/14_BTTF.png",
    "source" : "https://github.com/peerdavid/Watchy/tree/master/examples/WatchFaces/David",
    "ota_bin" : false,
    "version" : "1.0.0"
    },
  • Steps
    {
    "id" : "17",
    "name" : "Steps",
    "author" : "peerdavid",
    "screenshot" : "/img/watchfaces/17_Steps.png",
    "source" : "https://github.com/peerdavid/Watchy/tree/master/examples/WatchFaces/David",
    "ota_bin" : false,
    "version" : "1.0.0"
    },
  • Analog (the second one)
    {
    "id" : "20",
    "name" : "Analog",
    "author" : "peerdavid",
    "screenshot" : "/img/watchfaces/20_Analog.png",
    "source" : "https://github.com/peerdavid/Watchy/tree/master/examples/WatchFaces/David",
    "ota_bin" : false,
    "version" : "1.0.0"
    },
  • BCD
    {
    "id" : "22",
    "name" : "BCD",
    "author" : "peerdavid",
    "screenshot" : "/img/watchfaces/22_BCD.png",
    "source" : "https://github.com/peerdavid/Watchy/tree/master/examples/WatchFaces/David",
    "ota_bin" : false,
    "version" : "1.0.0"
    },
  • LCARS
    {
    "id" : "25",
    "name" : "LCARS",
    "author" : "peerdavid",
    "screenshot" : "/img/watchfaces/25_LCARS.png",
    "source" : "https://github.com/peerdavid/Watchy/tree/master/examples/WatchFaces/David",
    "ota_bin" : false,
    "version" : "1.0.0"
    },

"X marks the spot" watch face image on Watch Faces page does not display with EasyPrivacy adblock list

With EasyPrivacy added to an adblocker (website, direct link), the "X marks the spot" watch face image on Watch Faces page does not load, and it looks like this:

image

This is because of the URL to the preview, which has /x.gif? in the name:

{
"id" : "34",
"name" : "X marks the spot",
"author" : "c2c2",
"screenshot" : "https://github.com/theRealc2c2/x-marks-the-spot/blob/main/x.gif?raw=true",
"source" : "https://github.com/theRealc2c2/x-marks-the-spot",
"ota_bin" : false,
"version" : "1.0.0"
},

x.gif is a typical filename used for "spy pixels," and the adblocker cannot discern that this is actually a desired image. More information about this here: https://en.wikipedia.org/wiki/Spy_pixel

Here is where this list blocks this image:

image

Steps to reproduce

  1. Install uBlock Origin to your browser.
  2. Add EasyPrivacy list from its website.
  3. Observe that x.gif for this watch face is not displayed.

Suggested fix

Use the direct link to raw.githubusercontent.com instead:

https://raw.githubusercontent.com/theRealc2c2/x-marks-the-spot/main/x.gif

The link currently shipped to watchfaces.json redirects to this link ☝️ anyway:

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.