macchina / docs Goto Github PK

Hello,
Sure you can make fun of me for this, but it has happened to me at least 5 times in the last month. I am in the "docs" portion of the website. I am looking for a link to the main website which includes the store and I cannot find the link. No matter what I click on it wont take me to the main site. I am suggesting that there should be links to get you out of "docs" and back to the main site.

respect,
VoltVisionFrenchy (aka Steve French).

Unless we do some work to fix the base-url of links, this is currently only hosts correctly when it is hosted at the top level of the domain.

We should add a CNAME file indicating a 3rd-level domain this will be hosted at and enable GitHub pages hosting.

The standard GitHub pages 404 page has no navigation back to the guide so users would need to manually fiddle with the url if they encounter a broken link. We should add a custom 404 page that either automatically redirects to the home page or is styled and has navigation.

On at least some systems (Mac for certain) it's necessary to select the port (/dev/cu.usbmodem*) to which the device is attached before attempting to upload a sketch for the first time.

Not doing this leads to some unhelpful diagnostics.

The license needs to same width as the other content. It also appears at the bottom of pages.

The left most column of pin mapping table is cut off.

Hi,
Can you upload the BOM list of the project?

Thank's.

It would be nice if it were easy for users to go from reading a page in the book to being able to actually edit that page.

Perhaps something like the "Edit this page on GitHub" link in on the gPodder documentation, though, perhaps with a note about a free account being required.

Adding the macchina logo as the favicon should be easy to do. We just need someone to take the time to do it.

Unlike the 'generic' Arduino LED, the M2 LEDs are on when the output is low.

If a new user's first exposure to the LEDs is via the LED_BUILTIN define and the Blink example, they're going to be confused when the LEDs don't come on when they set the pin HIGH (since the example says HIGH is on...)

In the "flash SuperB with M2" guide, instead of altering the esp32 dev settings.
Have the user add the SuperB settings as an option in the boards menu.
One other big plus for me atleast is that I don't have to scroll a bunch in the list when switching between tha M2 and the SuperB.

This is my modified boards.txt from the esp32/.../.../... folder.

boards.txt

I'd like to add an I2C port (Stemma QT/QUIIC) to the back of the SuperBX. Can you provide Gerber or Eagle design files?

The orange links really stood out to me on first run. The main macchina website uses the conventional blue and having them all orange seemed loud to me, but perhaps it is just first impression.

Should we instead use traditional link colors within the book content?

/cc @ndiesslin

Just needed to do some "shotgun debugging" and realized I wasn't sure how to do that with Arduino (Morse on an LED? :-P ), normally the Hello World program provides the needed pieces to be able to do that.

I think adding a more conventional "Hello World" using SerialUSB would address this.

Right now the default GitBook theme is used. While this reads well, it would be nice to have more connection with the Macchina brand to make it look more official.

As a static site hosted on GH Pages, we have no means to track page popularity short of JS-based analytics.

@rocketjosh Should this be given its own analytics identifier or use the same one as the main macchina.cc domain?

Anyone finding the repository will see the license information; however, it would also be good to display the license information within the guide (footer perhaps), so that more casual readers will know about it.

There are a number of images in the guide that point to external sources or are otherwise broken. These need to be identified and should be fixed, removed, or replaced as appropriate.

NB. care needs to be taken with displaying external images to properly attribute them and indicate they do not fall under this repository's license.