Outline new docs #21
Outline new docs #21
Conversation
|
The outline document is not actually part of the documentation and can be removed later. Doesn't need to be proof-read or anything :) |
| to use a NervesKey with the `:primary` key slot and default I2C bus. | ||
|
|
||
| ```elixir | ||
| config :nerves_hub_link, |
There was a problem hiding this comment.
You may want to explicitly add connect: true to this example. Depending on how a users config is setup they may put connect: false in a previous config and then the device will not connect.... ask me how I know ;)
There was a problem hiding this comment.
Fun :)
I'd like the config to be minimal, there are many defaults. But that's an interesting gotcha.. might add a note on it as an option.
|
Note to self: |
nshoes
left a comment
nshoes
left a comment
There was a problem hiding this comment.
This is wildly helpful, thanks Lars! FWIW I read through everything and it LGTM.
To whoever is interested. I made an outline for what I think the docs need in terms of providing a clear path to success and step-by-step instruction.
I've also added a draft for the Shared Secret/Quickstart part of it.
Not precious about any of it, but I think this is the type of tutorial that is missing based on questions we've had. There are also needs to explain a bunch of stuff around CAs and whatnot. But this would get people set up I reckon.
Have logged a few issues in the CLI repo that could help cut down on some noise in the guide as well.