search

nodebots / johnny-five.io

The repo for the johnny-five.io website by bocoup
http://johnny-five.io
MIT License
35 stars 23 forks source link

Color page 404s from examples, Color pages not seen in API #70

Open nodebotanist opened 8 years ago

nodebotanist commented 8 years ago

Hey,

I found out there are color sensors because I was rooting around in the source. When I checked out the color examples (such as http://johnny-five.io/examples/color-ISL29125/), the link to the color API page 404s. I see some color-* files in the docs folder.

I can tackle this if you like, I'd just like to know which path you'd want me to take: 1) combine the 3 docs pages in docs/color-.md into one color.md 2) create a color.md that indexes the three docs pages /docs/color-.md 3) some other path I haven't thought of.

rwaldron commented 8 years ago

This only happens because all of that content is generated from two different sources. I haven't gotten around to creating an actual API entry for Color, which is why the 404 exists. The example generator automatically matches known class names found in a featured example's source and makes a list that is then output as links at the bottom of the example. There's no check to see if that wiki API page exists because that really shouldn't be necessary, because they should exist. I haven't documented Color, Light or Keypad because the examples are self explanatory and there hasn't been any real urgency to document.

rwaldron commented 8 years ago

So the only correct action to take is make the pages in the wiki.